reStructuredText
For the eZ components we are currently writing introductionary tutorials for each component. These tutorials should be a first start in understanding the abilities of each specific component without having to go through the full API documentation.
As good programmers we hate to document and thus the easier we can make the process the better documentation we will get. For our internal documents we use plain text files in SVN, describing guidelines and conventions. Those text files are formatted using reStructuredText , a format used by the Python community. It is a very easy to remember syntax, wiki-like, and it is easy to convert to HTML. We also decided to used the same format for our tutorials because it is such an easy format. With a specific PHP script we generate HTML from the tutorials, and add links to the other documentation that is generated by phpDocumentor from our inline API documentation.
Comments
Did you also check markdown and what where your reasons to choose restructured text?
Basically because some of us were already familiar with it. For example I've been using it to document Xdebug's DBGp protocol (http://xdebug.org/docs-dbgp.php). I had also never heard of markdown before, but their syntax seems to be very similar to the one that reStructuredText uses.
Another important benefit of using reStructuredText is that the documentation file (source) without parsing is also very readable.
Life Line
Updated a cafe
Specify street/place names to addresses
Specify bicycle parking capacities
Specify bicycle parking fees
Specify bicycle parking access
Specify whether crosswalks have tactile paving
Specify width of opening
Specify whether pitches are lit
Specify pitch surfaces
Specify whether pedestrian crossings have markings
Specify step counts
Survey tactile paving on steps
Specify whether steps have a ramp
Specify which way leads up for steps
Specify whether pedestrian crossings have islands
Specify whether pedestrian crossings have traffic signals
Determine roads lane count
Specify whether roads have lane markings
Survey if places still exist
Specify whether roads have sidewalks
Survey postbox collection times
Survey opening hours
Determine whether ATM allows depositing cash
Specify bicycle parkings covers
Shortlink
This article has a short URL available: https://drck.me/r-4nt