Software Document Authoring Wizard

Source: Internet
Author: User
Tags manual documentation
Document ClassificationThe project includes the following categories of documents, project management documentation. Including: "Software project Plan", "Project progress Report", "Project development Summary Report" Software development document. Include: "Requirements Specification", "Outline design Instructions", "Detailed design instructions." Software Test documentation. Includes: "Test Plan", "Software Test analysis Report". Product information. Includes: User's Manual of operation. version number of the documentThe version number of this project document is composed of two digits separated by dots, the first digit is the publication number, and the second number represents the revision number of the version. The specific usage is as follows: When the first edition of the document, the version number is V1.0, when the document is locally revised, the publication number is unchanged, the revision number is 1. For example, the first revision of a primary document is V1.1, and the publication number increases by 1 when the document is fully overwritten or the cumulative amount of local revisions results in a global change in the document. For example, a comprehensive revision is made on the basis of the V1.5 version, and the new version number is V2.0. Document identification items produce documents that have unique, specific encodings that are composed of the following: Project flags-Task identification-document type-number in the document tree-version number/serial number among them: Project Logo: This item is identified as "XXXX". Task ID: Less than eight letters, a brief identification of the task, the standard xxxx is "STANDARD". Document for the entire project, which is identified as "XXXX". Document type: Two-bit letter encoded from the table below. Number: reflects the document type (filled in according to the following table) version number: The version number of this document.     Serial number: four-digit encoding that indicates the total ordinal number of the document in the Project document library. One example of a document encoding is: XXXX-XXXX-SP-2N01-V1.0/0015 Table 5.3 Document classification of items
Document Type Coding number Notes
Project Management Project Development Plan Pp 1002 Project Plan
Project Progress Report PR 1003 Project
Software development Software Project plan Sp 2n01 Software Plan
Software Requirements Specification Sa 2n02 Software anlaysis
Software Design Instructions Sd 2n03 Software Design
Software Testing Software Test Plan Tp 4n01 Testing plan
Software Test Analysis Report Tr 4n02 Tesing
Product documentation User manual RU 5n01 User Guide
The identification list of all documents in this project will be specifically defined in the project development plan. Template for writing documents for all tasks in this project will be written according to the unified template (format and content Conventions). Includes template-Software development plan template-Software Requirements Specification template-Software design instructions template-Technical note document templates are stored in the configuration administrator.   and distributed to the author of the document. It is important to note that a document template is a unified convention for the document structure and layout of the project, and for specific documents, authors can add chapters as needed and, in principle, do not delete chapters (you can write "This chapter/section has no content"). When a document template does not conform to the requirements of the creator, the writer should contact the project leader to determine the standard for writing the document.   With regard to the technical note in the package, a technical note should be included to provide a detailed description of the source of the Code and the modification of the product. In the technical note, the following should be included: A list of code packages, in the form:
Code Package name Source version description of the function
Where the source can be: A list of downloaded network addresses, copy, and create code files, in the form:
Code Package name file name State modified by/author Last modification Time
Where the 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                    Approval                                  year      Month      Japan                   Development Unit                                                                                                                 System Specification (Systems specification)A     Introduction A.      Scope and purpose B of the document. Overview 1. Goal two.     function and Data Description A. System Structure 1. Structure diagram 2. Structure diagram description three.     Subsystem Description A.      Structure diagram specification B for subsystems.     Structure Dictionary C. Structural connection diagram and illustration 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 plan (Software project Pl
Related Article

Contact Us

The content source of this page is from Internet, which doesn't represent Alibaba Cloud's opinion; products and services mentioned on that page don't have any relationship with Alibaba Cloud. If the content of the page makes you feel confusing, please write us an email, we will handle the problem within 5 days after receiving your email.

If you find any instances of plagiarism from the community, please send an email to: info-contact@alibabacloud.com and provide relevant evidence. A staff member will contact you within 5 working days.

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.