Documentation Header Spec
Table of contents
- 1. Introduction
- 1.1. Intended Audience
- 1.2. Additional information
- 1.3. References
- 2. Status
- 3. Functional Specification
- 4. Technical Specification
- 4.1. UI requirements
- 4.2. API requirements
Introduction
With the growth of documentation on MCP, we need to reinforce the classification of documentation to make it easier to organize and discover information. With this in mind I'd like to have a header at the top of all documentation that call out key points of the article like version of MindTouch it applies to etc (More defined below). The header will provide a visual cue for the readers that will qualify the documentation more.
Intended Audience
All users of MindTouch.
Additional information
Initially this header will only be applied to the knowledge base and then possibly expanded to the User Manual.
References
| Applies to | MindTouch 9.12 or later | License | All versions |
|---|---|---|---|
| Operating System | All | Documentation Types | Unclassified |
| Community | |||
Status
Initial implementation created. Waiting for feedback from the dev team.
Functional Specification
The header will be at the top of all documentation articles
Use Cases
Here are the questions that this header will be able to answer for users navigating documentation:
- Is this documentation deprecated?
- @coregy Should users be directed to a more updated document if applicable?
- Does it only apply to Commercial installs?
- What Operating Systems is it relevant for?
- Is this documentation certified by MindTouch Staff? This will dictate more of the supported documentation
- What topics does this documentation cover?
Non-goals
Cook me dinner
Technical Specification
UI requirements
Need to format the header to match the Developer skin along with adding additional visual elements tied to conditional meta data
i.e. if the documentation is MindTouch Certified then a badge/logo will be shown that confirms it is MindTouch Certified otherwise the badge will not be shown
Maybe have a visual change if the documentation only applies to Commercial installations
API requirements
NA
- Tag page
- What links here
| Images 0 | ||
|---|---|---|
| No images to display in the gallery. |
Copyright © 2011 MindTouch, Inc. Powered by