Description
projectdoc provides two ways of organizing document. One is by type, the other by semantics.
Ordering by type allows readers to find the information at well known places, since it is a standard that can be used in every project. Software developers using Maven are used to this kind of structuring: in every project the source files are found in src/main, the test files in src/test and so on.
Home and index pages support organizing documents by type. For a project documentation this results in having the project roles, stakeholders, tags, and categories (just to name a few) all in one place. At the same place for all projects using projectdoc. The homepage contains the central documents of their types. For roles these central documents provide information about the root roles of the project.
In the given example we use the following roles:
- Ops (Operations)
- QRT (Quick Response Team, a special branch of Operations)
- Users (Users of the system under development)
Index pages are linked to homepages and show all documents of the given doctype (up to a maximum according to the result set size). This is useful for readers that want to get an overview over all documents of a given type.
