Document Structure Guideline
Overview ¶
Generally there are two types of wikis, one is Customer Oriented, the other is Engineer Oriented.
Customer Oriented wiki (AKA User Guide) focuses more on high-level functions, which helps end user better know and use our product; Engineer Oriented wiki (AKA Developer Guide) should contains more detailed contents, like product framework, feature's underlying mechanism, and team standard, it's purpose is to help developer build a knowledge base, which contributes to team's coorperation.
In other word, the first type of wiki tells us WHAT, and the second type explains HOW and WHY.
Recommended Wiki Structure ¶
Since the goal of two types of wiki is different, so their structure are different. Below listed the recommended structure of each type.
Customer Oriented Wiki (External) ¶
- Introduction
- Getting Started
- Index of Glossary (other important links)
- Basics
- e.g. Concept
- e.g. Key Functionality
- ...
- Advanced
- e.g. Administration
- e.g. System Configuration
- ...
- FAQ
- Appendix
- Glossary
- ChangeLog / Release Note
- Feedback
- ...
Engineer Oriented Wiki (Internal) ¶
- Home
- Getting Started
- Architecture Introduction
- Core Feature Index
- New Member Checklist
- Development Tutorial
- ...
- System Overview
- Project Framework
- Environment Information
- Functionality Overview
- ...
- Knowledge Base
- Feature Design
- Manual / Tutorial of Core Feature
- Runbook
- ...
- Standards
- Architecture Standard
- Code Quality
- Process Standard
- Agile Process
- Development Process (Git Flow)
- Release Process (CMC / CDP)
- ...
- Event Note
- Knowledge Sharing
- Release Note
- Issue Recording
- Process Recording
- ...
- API Doc
- Modules - List of subcomponents.
- e.g. Cloud Agent
- e.g. MCT Plugins (Plugin List)
- e.g. Common Service
- e.g. Java Plugin Framework
- ...
- FAQ
- Appendix
- Glossary
- Feedback
- ...
Overall Structure ¶
