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):||22 December 2008|
|PDF File Size:||9.69 Mb|
|ePub File Size:||12.81 Mb|
|Price:||Free* [*Free Regsitration Required]|
General requirements and processesexplain how to do this in a consistent and useful way. This article is intended to help content creators evaluate, select, and apply appropriate standards. They ensure that the information content, structure and format are suitable for the intended audience.
It is independent of documentation development or management tools or methodologies. Why we need standards Software providers want their products to be usable.
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, lso, procedures, descriptions, specifications, requests, and reports. 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 isp search capability.
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 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 provides requirements for strategy, planning, performance, and control for documentation managers. 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.
Standards for software documentation Standards can greatly assist technical writers, documentation managers, designers and developers. Designers and developers writers and illustrators.
Content of software documentation is tied to fulfilling data quality characteristics of completeness and accuracy. It is not limited to the test and review phase of the life-cycle, but includes activities throughout the information management and documentation management processes. Shell Georgia – ISO Standards for software documentation are important tools for technical writers. Find out more about tcworld. BoxWindermere, FL Relation to user documentation.
Documentation is often regarded as something done after the software has been implemented. The process sections include analysis of audience profiles, tasks, and usability goals and objectives, with some coverage of life-cycle management.
November AR headset prevalence still a few years out. In theory, it kso be possible to prepare each of these types of document for each process used in a project. If the information is supplied in a convenient form, and is easy to find and understand, we can quickly become proficient at using the product. In practice, the specific information items is for a project should be limited to those needed by stakeholders, with information reused and isi throughout a software portfolio.
And they can help other stakeholders concerned with software processes, including software users. They provide content creators with the requirements for information products and guide them through the process of developing such products.
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.
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 also covers formats iiso illustrations and page design.
ISO/IEC | Article about ISO/IEC by The Free Dictionary
Search hundreds of articles in our extensive Newsletter Archive. A longer German version of this article appears in Anthology on Technical Communicationed.
User documentation is an essential component of usable software products. It includes requirements for the processes of strategy and planning, designing, engineering, evaluating and testing, and sustaining websites for technical information. Regarding format, discusses the choice of appropriate printed or electronic media.
It includes requirements for a user documentation management plan and a documentation plan. It covers both the process and the documentation product content, structure, and formatand includes an annex on the content of style guides and another on writing style and techniques in English.
Software users consult documentation in three main modes:. 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.
ISO/IEC – Standards Australia
December Turning technical documentation into intelligent information. Although software developers aim to design user interfaces that behave so intuitively that very little separate documentation is needed, this is rarely possible in practice.
However, for high-quality, effective software documentation, its development should be regarded as an isk part of the software life-cycle process.
For example, certain topics such as software installation are required to be available in printed form separate from the software.
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.
Sections on 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”. If done properly, documentation or information management is a large enough task to require process planning in its own right.
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.
This agreement is intended to reduce duplication of effort by encouraging:.
Definition: ISO/IEC 26514
Sections on the structure of documentation describe where to appropriately place information and critical information such as warnings. December Global wearable device sales to grow 26 percent in Its documentation may be the first tangible item we see, and therefore, influences our first impression of the software product. The generic types are identified as policies, plans, procedures, descriptions, specifications, requests, and reports.