World Library  
Flag as Inappropriate
Email this Article

Technical documentation

Article Id: WHEBN0020612397
Reproduction Date:

Title: Technical documentation  
Author: World Heritage Encyclopedia
Language: English
Subject: Regulation and licensure in engineering, ReStructuredText, Deliverable, User analysis, European Space Weather portal
Collection:
Publisher: World Heritage Encyclopedia
Publication
Date:
 

Technical documentation

In engineering, technical documentation refers to any type of documentation that describes handling, functionality and architecture of a technical product or a product under development or use.[1][2][3] The intended recipient for product technical documentation is both the (proficient) end user as well as the administrator / service or maintenance technician. In contrast to a mere "cookbook" manual, technical documentation aims at providing enough information for a user to understand inner and outer dependencies of the product at hand. The technical writer's task is to translate the usually highly formalized technical documentation produced during the development phase into more readable prose.

The documentation accompanying a piece of technology is often the only means by which the user can fully understand said technology; regardless, technical documentation is often considered a "necessary evil" by developers. Consequently, the genre has suffered from what some industry experts lament as a lack of attention and precision.[4]

Forms of technical documentation

Technical documentation may include:

During development, a multitude of document types will play a significant role:

and various intermediate or intervening documents thereof.

Standardization of forms

Traditionally, most forms of technical documentation have lacked recognized standards, though this is changing.[4] So far, ISO has published a series of standards related to technical product documentations and these are covered by ICS 01.110.[5] The ones that are not covered by ICS 01.110 are listed in the subsection below.

Discipline specific

Technical documentation formats

See also

Citations

  1. ^ What is "technical documentation"? at Transcom.de. Accessed February 25, 2013.
  2. ^ What is Technical Documentation? at Tetras Translations. Accessed February 25, 2013.
  3. ^ Documenting the New System at IGCSE ICT. Accessed February 25, 2013.
  4. ^ a b The Documentation Scene by John Mobbs. Institute of Scientific and Technical Communicators, Monday, July 23, 2012.
  5. ^ "01.110: Technical product documentation".  
  6. ^ "ISO 15787:2001 Technical product documentation -- Heat-treated ferrous parts -- Presentation and indications".  
  7. ^ "ISO 3098-0:1997 Technical product documentation -- Lettering -- Part 0: General requirements".  
  8. ^ "ISO 10209-1:1992 Technical product documentation -- Vocabulary -- Part 1: Terms relating to technical drawings: general and types of drawings".  
  9. ^ "ISO 2162-1:1993 Technical product documentation -- Springs -- Part 1: Simplified representation".  
  10. ^ "ISO 5457:1999 Technical product documentation -- Sizes and layout of drawing sheets".  
This article was sourced from Creative Commons Attribution-ShareAlike License; additional terms may apply. World Heritage Encyclopedia content is assembled from numerous content providers, Open Access Publishing, and in compliance with The Fair Access to Science and Technology Research Act (FASTR), Wikimedia Foundation, Inc., Public Library of Science, The Encyclopedia of Life, Open Book Publishers (OBP), PubMed, U.S. National Library of Medicine, National Center for Biotechnology Information, U.S. National Library of Medicine, National Institutes of Health (NIH), U.S. Department of Health & Human Services, and USA.gov, which sources content from all federal, state, local, tribal, and territorial government publication portals (.gov, .mil, .edu). Funding for USA.gov and content contributors is made possible from the U.S. Congress, E-Government Act of 2002.
 
Crowd sourced content that is contributed to World Heritage Encyclopedia is peer reviewed and edited by our editorial staff to ensure quality scholarly research articles.
 
By using this site, you agree to the Terms of Use and Privacy Policy. World Heritage Encyclopedia™ is a registered trademark of the World Public Library Association, a non-profit organization.
 



Copyright © World Library Foundation. All rights reserved. eBooks from World eBook Library are sponsored by the World Library Foundation,
a 501c(4) Member's Support Non-Profit Organization, and is NOT affiliated with any governmental agency or department.