Document Standardization (wiki structure) Meeting Minutes

Meeting Info ¶

Meeting Agenda ¶

1. Review and discuss about wiki structure(15mins) - I will present a prototype, and we can have a brainstorm based on it(I will send it out before our meeting).
2. How to keep document updated(15mins) - Make Documentation as part of development process? - Evaluate doc effort on planing meeting? - Make Doc more close to project? - Acceptance test for Doc? - Remove All invalid / useless docs?
3. How to write document(10mins) - Doc Template? e.g. heading with background, what, why, how... Principle: simple and concise - Unified content format / style to make our wiki more profisional? some reference: - Dubbo 博客文档中文排版指南 - Cisco - Google - Apple - Microsoft

Meeting Minutes / Action Items: ¶

Wiki structure ¶

The final result of the discussion is that some changes have been made in the current structure, as follows: - Need define Basic functions and Advanced functions in advance. - The link of important articles is listed under the Get Started directory. for example: glossary. - FAQ == troubleshooting

Keep document updated ¶

• Make document as part of development process .
• Evaluate document effort on planning meeting.
• Need review document. Generally, big feature , design feature, research must produce documents. Other functions need to consider whether there are existing documents that need to be updated.
• Remove all invalid/ useless documents. step by step migration. If you produce a new document , put it directly to the new address. If a document exists, migrate it.
• We need to check whether there is a one click migration tool.
• Move code to GitHub( need to discuss). GitHub is more conducive to standard development.
• Use Readme

How to write document ¶

• Document template. e.g. heading with background, what, why, how... principle: simple and concise
• Unified content format/ style. Extract useful parts from some tutorials to form own specification documents(JIRA needs to be formed). Markdown can unify document specifications.
• How to store pictures
• The above needs a document to let everyone understand the specification and guide how to use relevant tools. Need share meeting.

Tentative topics for the next meeting ¶

• Which documents are migrated first?
• Website construction
• Unified content format/ style.(topic 3 will form JIRA)
• Code style(scalability, readability, etc)

Jira AI from meeting ¶

1. Document style guide specification for Monitoring & Alerting