项目总结- Summary of project

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.

 

 

一、开始制作文档之前，了解公司与项目组的文档规范，确定文档的大致框架。

二、制作文档时考虑文档的可读性与文档的可维护性。

三、在文档中使用不同的颜色或风格标志不同的含义，并在前面有说明

四、制定项目的工作流程，流程中职责分明，随着项目的进展不断更新。

五、对于需要不断更新的文档，最好定个时间段来更新文档。

六、制作文档过程中应该细心，并且有耐心

七、对于文档信息的来源要积极主动去获取，多与开发人员与测试人员沟通，获得最新的信息。

八、文档要有版本控制。