Documentation Guidelines

Documentation for users and developers of SASUnit should follow the following standards:

Structure

Documentation is structured into books, chapters, sections and subsections and so on which are hierarchically linked wiki pages. Main page is Home. We have two books - User's Guide and Development Guidelines. For each book there is a hierarchical structure in linked subpages. Pages should be approximately the same size.

Linking and back linking

Every page has a list of links to subpages and a back link to the parent page at the end.

Because of the markdown syntax used by the SourceForge environment, link texts have to be specified twice in order to avoid display of square brackets which are distracting. The following links to this page: [Documentation Guidelines](Documentation Guidelines) and results in Documentation Guidelines. The text in square brackets is the displayed text, the text in round brackets is the page being linked to. Omitting the second part in round brackets results in [Documentation Guidelines].

Language

Language is always English.

Back to Development Guidelines.