Software Document Authoring Wizard

Document ClassificationThe project includes the following categories of documents, project management documents. Includes: Software project plan, Project progress report, Project development Summary report software development document. Include: "Requirements Specification", "Summary Design Notes", "Detailed design instructions". Software Test documentation. Includes: "Test Plan", "Software Test analysis Report". Product information. Includes: User operating manual. Version number of the document the version number of this project document consists of two numbers separated by dots, the first number represents the publication number, and the second number represents the revision number of the version. The specific usage is as follows: When the document is first published, the version number is V1.0, and when the document is partially revised, the publication number is unchanged and the revision number is increased by 1. For example, the first edition of the document was revised with the version number V1.1, and the publication number increased by 1 when the document was fully rewritten or the local revisions accumulated more frequently causing the document to change globally. For example, a comprehensive revision was made on the basis of version V1.5, and the new version number is V2.0. Identification of the document
The document produced by the project has a unique, specific code that is composed of the following: Project flag-Task ID-Document type-number in document tree-version number/ordinal where: Project mark: The Project logo indicates that this project is "XXXX". Task ID: Less than eight letters, a brief identification of this task, standard xxxx is "standardized." The document that applies to the entire project, which is identified as "XXXX". Document type: Two-bit letter encoding from the following table. Number: reflects the document type (filled in according to the following table) version number: The version number of this document.     Sequence Number: A four-digit numeric code that indicates the total ordinal number of the document in the Project document library. A document encoding example is: XXXX-XXXX-SP-2N01-V1.0/0015 Project document Classification table

Document Type	Coding	numbering	Notes
Project Management	Project Development Plan	Pp	1002	Project Plan
Project Progress Report	PR	1003	Project Report
Software development	Software project Planning	Sp	2n01	Software Plan
Software Requirements Specification	Sa	2n02	Software anlaysis
Software Design Notes	Sd	2n03	Software Design
Software Testing	Software Test Plan	Tp	4n01	Testing Plan
Software Test Analysis Report	Tr	4n02	Tesing Report
Product documentation	User manual	RU	5n01	User Guide

The identification list of all documents in this project will be defined in the project development plan. Document Authoring template documents for all tasks in this project will be prepared according to a uniform template (format and content conventions), including: template-Software development plan template-Software Requirements Specification template-Software Design note template-Technical Notes document templates are saved in the configuration administrator,   and distributed to the author of the document. It is necessary to note that the document template is the document structure and layout of the Uniform Convention, for specific documents, the writer can add chapters as necessary, in principle do not delete chapters (can write "this chapter/section no Content"). When a document template does not meet the writer's requirements, the writer should contact the project leader to determine the document's writing criteria. Writing a template for a document
In the package, a technical note should be included detailing the source and modification of the product's code. In the technical note, the following should be included: A list of code packages in the format:

Code Package name	Source	version	description of the function

where "source" can be: Download the network address, "Copy", "create" The code file list, in the form of:

Code Package name	file name	State	modified by/author	Last Modified Time

Where "status" can be: "Modify", "delete", "create", "as is" cover Format:                                                                                                                                                    Document Number                                                                     Version number                                               Document Name:                                                      project Name:                                                       Project leader:                                               Writing                                  year      month      Day                    Proofreading                                  year      month      Day                    Audit                                  year      month      Day                    Approvals                                  year      Month      Japan                   Development Unit                                                                                                                 System Spec Sheet (Systems specification)A     Introduction A.      The scope and purpose of the document B. Overview 1. Target two.     function and Data Description A. System Architecture 1. Structural Relationship Diagram 2. Structure diagram description three.     Subsystem Description A.      Structure diagram specification for subsystem B.     Structure Dictionary C. Structural Connection diagram and description four.     System modeling and simulation structure A.      System model B for impersonation.     Simulation Results C. Special Performance Five. Software project issues A. Software Project plan six. Appendix Software project planning (software project plan)