How to implement ISO/IEC/. IEEE in your workplace. (And why you should care about standards). George Hayhoe. Mercer University School of. Implementing ISO/IEC in your workplace (And why should technical communicators care about standards, anyway?) George Hayhoe. Buy CSA ISO/IEC SYSTEMS AND SOFTWARE ENGINEERING – REQUIREMENTS FOR DESIGNERS AND DEVELOPERS OF.
|Published (Last):||8 March 2009|
|PDF File Size:||20.66 Mb|
|ePub File Size:||3.41 Mb|
|Price:||Free* [*Free Regsitration Required]|
Annette ReillyPh. She retired as a senior staff member from Lockheed Martin, where she held a variety of responsibilities for proposal management, engineering management, systems engineering, information management, and technical documentation.
A longer German version of this article appears in Anthology on Technical Communicationed. Standards can greatly assist technical writers, documentation managers, designers and developers. But which standard applies to which team member and which ones are most useful in software documentation?
265114 for software documentation are important tools for technical writers. They provide content creators with the requirements for information products and guide them through the process of developing such products.
They ensure that the information content, structure and format are suitable for the intended audience. And they can help other stakeholders concerned with software processes, including software users. This article is intended to help content creators evaluate, select, and apply appropriate standards. Software providers want their products to be usable.
Software users consult documentation in three main modes:. Thus, software providers have an obligation to warn users when the software might create hazardous conditions, and to advise users when incorrect use of the software could result in unsatisfactory results. General requirements and processesexplain how to do this in a consistent and useful way.
Relation to user documentation.
Editors, reviewers, testers, and assessors. Designers and developers writers and illustrators. It covers both the process and the documentation product content, structure, and formatand includes an annex on the content of style guides and another isso writing style and techniques in English. The process sections include analysis of audience profiles, tasks, and usability goals and isi, with some coverage of life-cycle management. Sections on the structure of documentation describe where to appropriately place information and critical information such as warnings.
They specify document components such as package label or title page, table of contents, concept of operations, procedures, error messages and problem resolution, navigational features, index and search capability. Content of software documentation is tied to fulfilling data quality characteristics of completeness and accuracy.
Sections isk the information content allow for minimalist approaches while making sure that all critical software functions are covered in the documentation “software whose failure could have an impact on safety, or could cause large financial or social loss”. Detailed requirements for the content and structure of procedures instructions reflect their importance for software documentation users. The standard also includes requirements for the content of error messages and warnings critical 2514 information.
Regarding format, discusses the choice of appropriate printed or electronic media. For example, certain topics such as software installation are required to be available in printed form separate from the software.
It also covers formats for illustrations and page design. As team members, they can contribute to several tasks along with designing and developing user documentation, such as recording development plans and user stories, contributing to GUI design, managing changes to requirements, leading or performing usability testing, and tracking progress during sprints.
This standard recommends that documentation be complete and tested before a sprint is closed. Websites can provide quick access to information, an accessible way to acquire and evaluate knowledge and concepts, and a way to share information and opinions among a user community.
It includes requirements for the processes of strategy and planning, designing, engineering, evaluating and testing, and sustaining websites for technical information. Website management considers the lifespan of the website and its information, configuration control, and estimation of resources for site sustainment. Website design strategy focuses on the separation of content and presentation, use of consistent design, separation of marketing and information, choice of multimedia, performance concerns, and special considerations for website translation and localization.
Requirements for search functions and site navigation and privacy policies are emphasized, including protecting the security of the website’s technical information, user data, and IT resources. Standardized information about software life-cycle processes and products helps organizations plan strategically, control their results, inform their stakeholders, and streamline their processes, with the goal of improving their software products.
It specifies the content of information items from several perspectives:. The generic types are identified as policies, plans, procedures, descriptions, specifications, requests, and reports.
In theory, it would be possible to prepare each of these types of document for each process used in a project. In practice, the specific information items produced for a project should be limited to those needed by stakeholders, with information reused and repurposed throughout a software portfolio. Thus, does not prescribe the title, format, structure or exact content of specific information items, as long as the required content is available in some way.
It emphasizes planning for reviews for different purposes such as technical accuracy or editorial correctness at different points in the software and documentation life cycle. It describes managing the output of reviews, and resolving problems discovered during reviews and tests. It describes various purposes for testing documentation, including a system test for consistency between the software performance and the documentation, tests of accessibility and localization, and usability testing.
It covers organizing and planning for an ongoing workflow and documentation portfolio, including developing a team with specific roles, obtaining infrastructure resources, and establishing management control through measurement. It briefly describes the vexing concern of estimating resources for documentation projects.
It suggests measurements of documentation products, productivity, quality, and measures for process improvement, and includes suggestions to minimize the cost and improve the quality of translations. It includes requirements for a user documentation management plan and a documentation plan. It includes specific requirements for a component CMS: It can be applied within an organization as well as for external suppliers.
It covers what to include in a request for proposals request for tender and in a proposal, as well as monitoring and managing the agreement and handling changes that arise during the work. It details what needs to be defined in requirements for user documentation and 2651 a user documentation specification and statement of work. December Turning technical documentation into intelligent information.
ISO/IEC – Google Books
December Global wearable device sales to grow 26 percent in November CSA releases comprehensive machine translation research and video Series. November AR headset prevalence still a few years out. Find out more about tcworld. Standards for software documentation Standards can greatly assist technical writers, documentation managers, designers and developers. Why we need standards Software providers want their products to be usable.
Software users consult documentation in three main modes: Documentation for software organizations and projects Standardized information about software life-cycle processes and products helps organizations plan strategically, control their results, inform their stakeholders, and streamline their processes, with the goal of improving their software products.
It specifies the content of information items from several perspectives: Purpose and common content for typical information items generic types Specific content needed for various life-cycle processes Types of data to collect as records in data stores and use in documents The generic types are identified as policies, plans, procedures, descriptions, specifications, requests, and reports.