Skip to main content

Doc Title

  1. Quarter related docs a. Naming: name+year/quarter i. Ex: Frontend Plan F23Q3 b. If the document is under folder with name F23Q3, then all the docs under this folder do not need to add year+quarter. All the docs under this folder need date. i. Ex：Frontend Meeting F23Q3
        1. Doc Meeting 07/05/2022
        2. Info Metting 07/06/2022
        3. ...
  2. If it is a document that will be used every quarter, the document name does not need year + quarter. Just use the generic name. a. Example: Engineering Development Specification

Doc Standard​

A must-have for general documents (excluding meeting docs) is the changelog. For example:

Date(mm/dd/yyyy)Change InfoLeader signature
07/23/2022The first two steps has been deletedJoe

  1. After writing the document, you need to inform all related team members(A in RACI). After the document is reviewed, the team leader needs to sign and mark the time. If the document did not pass the review, the doc creator need to make corresponding changes and submit again.

  2. Each document needs to be notified to the person in charge for review, and the location of the document should also be reviewed, so that each team member has a good filing habit.

Dev Docs​

  • Functional documentation: Example
  • Criteria: Easy to read, and the next person to take over the job can understand right away.

Meeting Docs​

1. What is the meeting about
     a. Name of the meeting
     b. Location
     c. Time
     d. Participants
     e. Absentee
     f. MC
     g. Recorder
2. Topic
     a. Topic 1
        i. Conclusion
        ii. Important points
     b. Topic 2
        i. Conclusion
        ii. Important points
     c. Undecided issues
3. Follow-up arrangements
     a. who
     b. Delivery time
     c. To accomplish what
     d. What results should be delivered