- Created by Robert Reiner, last modified on 09. May 2017
projectdoc Toolbox
Categories, tags, and others allow to organize the pages in your wiki. First define categories pages with display table macros. Second tag your pages with these categories. With this two-step process it is easy to have multiple views to link to your information in your wiki.
- Expected Duration
- 10 min
- Type
As shown in Automatic Lists teams need a good navigation structure to browse their documentation easily. But teams have little to no time to create this navigation elements link-by-link manually.
The Display Table Macro allows to define queries to list all matching projectdoc documents. The projectdoc Toolbox also defines some generic document types to create different views on the documentation automatically. This way a team may provide different landing pages for different users with different documentation requirements. The number of views is not limited. Any doctype may define its own types to provide additional views.
What does such a view look like? A generic view would be defined by categories or tags. A type specific view can be defined by topic types (such as tutorials, tips, or training video) or role (to define the audience of documents).
Resources
Resources on organizing information.
Doctypes to organize your wiki:
Generic Categories
Generic categories organize documents independently of their actual type.
- Category
- Categories allow to set document instance of different doctypes in a hierarchy.
- Role
- Defines a role with its responsibilities, tasks and requirements. Roles are incorporated by stakeholders who take interest in the project. The are also used to define the audience for documents.
- Subject
- Subject documents allow to set document instance of different doctypes in a common context.
- Tag
- Document the semantics of a tag. May also be used to document Confluence labels.
Specific Categories
Specific categories are based on doctypes that define types for specific doctypes.
- Alternative Type
- Group your alternatives by a self-defined type.
- Architecture Alternative Type
- Group architecture alternatives by their type.
- Architecture Aspect Type
- Group architecture aspects by their type.
- Architecture Decision Type
- Architecture decisions are group by their types. A commonly used decision type is 'Architecture'.
- Artifact Type
- Artifact types categorize artifacts.
- Association Type
- Categorize associations by a type.
- Assumption Type
- Assumptions are grouped by their type.
- Blackbox Type
- Group blackboxes by their type.
- Category Type
- Categorize categories by a type.
- Charter Type
- Categorize charters by a type.
- Code Type
- Code types categorize codes, used in logging or exception handling.
- Component Type
- Component types categorize components.
- Data Type Type
- Data type types categorize data types.
- Decision Type
- Group your decisions by a self-defined type.
- Environment Type
- Type of an environment used by the project to deploy the application or the solution.
- Excerpt Type
- Categorize excerpts by a type.
- Experience Level
- Defines the context through which readers acquire skills. The level sets the expectation on the author's techniques to teach.
- Experience Level Type
- Categorize experience levels by a type.
- FAQ Type
- Categorize FAQs by a type.
- Feature Type
- Feature types categorize features.
- Generic Type
- Categorize generic documents by a type.
- Glossary Item Type
- Categorize glossary items by a type.
- Interface Type
- Group interfaces by their type.
- Media Type
- Resources are identified by their media type. This may be the MIME type, but also a human readable string, that identifies the syntactic format.
- Media Type Type
- Categorize media types by their type.
- Metadata Type
- Categorize metadata documents by a type.
- Minutes Type
- Group your minutes by a self-defined type.
- Module Type
- Categorization of document modules for single sourcing.
- Node Type
- Node types categorize nodes.
- Open Issue Severity
- Open issues are grouped by the severity of their impact on the project.
- Open Issue Status
- Open issues are grouped by the status.
- Open Issue Type
- Group your open issues by a self-defined type.
- Opportunity Type
- Opportunities are grouped by their type.
- Organization Type
- Categorize organizations by a type.
- Out Item Type
- Out item types categorize out items.
- Person Type
- Categorize persons by a type.
- Problem Type
- Problems are grouped by their type.
- Profile Type
- Categorize profiles by a type.
- Project Constraint Type
- Project constraint types categorize project constraints.
- Project Vision Type
- Types to categorize vision statements for projects.
- Property Type
- Property types categorize properties of products, such as parameters or configuration options.
- Quality
- Qualities describe desired aspects of the product.
- Quality Scenario Type
- Quality scenario types categorize quality scenarios.
- Quality Target Type
- Group quality targets by their type.
- Quote Type
- Categorize quotes by a type.
- Relation
- Organizes glossary items.
- Relation Type
- Categorize relations by a type.
- Release Note Type
- Group your release notes by a self-defined type.
- Report Type
- Group your reports by a self-defined type.
- Requirement Type
- Categorization of requirements for a product.
- Resource Type
- Resources are identified by their type. This is not the MIME type, but human readable string, that identifies the semantic, rather than the syntactic format.
- Risk Action Type
- Risk actions are grouped by their type.
- Risk Phase
- Risks are grouped by the phase of their impact on the project.
- Risk Probability
- Risks are grouped by the probability of having impact on the project.
- Risk Severity
- Risks are grouped by the severity of their impact on the project.
- Risk Target Type
- Risk tagets are grouped by their type.
- Risk Type
- Risks are grouped by their type.
- Role Type
- Categorize roles by a type.
- Section Type
- Categorize sections by a type.
- Space Index Type
- Categorize space indexes by a type.
- Stakeholder Type
- Categorize stakeholders by a type.
- Step Type
- Categorize steps by a type.
- Subject Type
- Categorize subjects by a type.
- Tag Type
- Categorize tags by a type.
- Technical Debt Type
- Technical Debts are grouped by the area they address.
- Test Case Type
- Test case types categorize test cases.
- Test Charter Type
- Test charter types categorize test charters.
- Test Data Type
- Test data types categorize test data.
- Test Report Type
- Test report types categorize test reports.
- Test Session Type
- Test session types categorize test sessions.
- Topic Type
- A topic type is a semantic type of the topic. It helps to set the expectations of potential readers.
- Use Case Type
- Use case types categorize use cases.
- User Character Type
- User character types categorize user characters.
- Version Type
- Categorize versions by a type.
- View Type
- Groups the views at a system.
- Whitebox Type
- Group whiteboxes by their type.