Summary of Documentation in Certification
In certification project, the task of our team is mainly installing Portal7.1 on a new environment with AIX5.3 and WebSphere 6.0, testing this software and fixing defects we have find.
My mainly job in this project is maintenance documents of defects both AIX and windows. This project will over on October 25, 2005 this Tuesday.
I make a summary about the documentation in this project in order to make a better job next time.
1. Before creating the documents, we should know the standard of documents in our company and our team and confirm about the mainly frame of the document.
2. Consider of readability and easy to maintenance.
3. Use different color and style to identity the different meaning of the sentences and add illustration in the document.
4. Make a clear workflow about the project, so everybody of our team can know his team clearly. And this workflow should be updated with the going of the project.
5. Because the info of the documents is changed so often, so we can decide when modify the document and send the document to all the team.
6. Should be more careful and patient during documentation.
7. Should get the information of document positively and actively and communicate with developers and QAs to get the latest information.
8. The version control should be done in documentation.
一、開始製作文檔之前，瞭解公司與項目組的文檔規範，確定文檔的大致框架。
二、製作文檔時考慮文檔的可讀性與文檔的可維護性。
三、在文檔中使用不同的顏色或風格標誌不同的含義，並在前面有說明
四、制定項目的工作流程，流程中職責分明，隨着項目的進展不斷更新。
五、對於需要不斷更新的文檔，最好定個時間段來更新文檔。
六、製作文檔過程中應該細心，並且有耐心
七、對於文檔信息的來源要積極主動去獲取，多與開發人員與測試人員溝通，獲得最新的信息。
八、文檔要有版本控制。
