Standards for Software Documentation
- Written by Brigit
This is a short list of international standards for software documentation that we find useful.
IEEE Recommended Practice for Software Requirements Specifications
IEEE Std 830-1998
Abstract: The content and qualities of a good software requirements specification (SRS) are described and several sample SRS outlines are presented. This recommended practice is aimed at specifying requirements of software to be developed but also can be applied to assist in the selection of in-house and commercial software products. Guidelines for compliance with IEEE/EIA 12207.1-1997 are also provided.
IEEE Recommended Practice for Software Design Descriptions
IEEE Std 1016-1998
Abstract: The necessary information content and recommendations for an organization for Software Design Descriptions (SDDs) are described. An SDD is a representation of a software system that is used as a medium for communicating software design information. This recommended practice is applicable to paper documents, automated databases, design description languages, or other means of description.
IEEE Standard for Software Test Documentation
IEEE Std 829-1998
Abstract: A set of basic software test documents is described. This standard specifies the form and content of individual test documents. It does not specify the required set of test documents.
IEEE Standard for Software User Documentation
IEEE Std 1063-2001
Abstract: Minimum requirements for the structure, information content, and format of user documentation, including both printed and electronic documents used in the work environment by users of systems containing software, are provided in this standard.
Systems and software engineering — Requirements for designers and developers of user documentation
ISO/IEC FDIS 26514
From the Foreword: This International Standard supports the interest of software users in consistent, complete, accurate, and usable documentation. It includes both approaches to standardization: a) process standards, which specify the way in which documentation products are to be developed; and b) documentation product standards, which specify the characteristics and functional requirements of the documentation.