ISO IEC IEEE 26515 pdf free download
ISO IEC IEEE 26515 pdf free download.Systems and software engineering一 Developing user documentation in an agile environment.
5.2 Life cycle software documentation in an agile environment
Designing, developing, and testing user documentation is greatly assisted by the presence of life-cycle documentation such as a documentation plan, system design document, system test plan, release records, and problem reports. Other formal documentation specific to the user documentation development process may be produced, such as style guides and organizational procedures for content management and documentation reviews.
ISO/IEC 15289:2011, Systems and software engineering — Content of life cycle information products (documentation) provides recommended contents for the production of required documents throughout the systems/software life cycle.
In projects using agile development, any life-cycle documentation that is included in the project is likely to be less detailed, and possibly less formal than in other types of development projects. Some documents, for example, detailed specifications and design documents may not be produced at all. Because of the focus on delivery of working software, not only are some of the documents that traditionally would be produced as a part of the software life-cycle process not being produced (or are significantly reduced in content), but some of the processes may be skipped altogether. For example, the development team may proceed straight from producing a high level architectural design to software coding and testing, skipping the production of a detailed design.
Communication of the intent and behaviour of the user documentation may instead be provided by face to face communication, rather than through the use of detailed, formal documentation plans.
The documentation that is produced and the level of detail within each document are likely to be project specific. The level of detail may be influenced by the size of the team, the location of the team, requirements of acquirers, and other contractual agreements. More substantial documentation is needed if the team works in different time-zones or locations. Small, collocated teams may prefer minimal documentation and a reliance on face to face communication, whereas large, multi-location teams are likely to require more detailed documentation for communication purposes and future reference.
The types, level of detail, and timing of the production of the documentation will vary between projects. When the focus is on the delivery of working code, a development team may not have planned to include the resources needed to produce large quantities of documentation. Mechanisms are still required to ensure that the software product and associated user documentation match the user requirements; however these may be defined on the project.
Projects using agile development may benefit from the introduction of alternative content storage systems, such as wikis, that enable content to be captured quickly and cheaply. These allow information to be rapidly updated, and to be shared across the development team, including the technical writers, both locally and across multiple sites and time zones. However, wikis tend to collect chronological information without structuring the content for usability.
5.3 Life cycle documentation in agile development
Life cycle documentation should be produced in projects using agile development to communicate the processes, requirements, and deliverables required of the teams working on the project. These documents may contain less detail than their counterparts in other software development methods. The life cycle documents produced by projects using agile development are named the same as in other software projects, but the amount of detail or specific contents may differ.ISO IEC IEEE 26515 pdf download.
