Zdroje informací
Technical Documentation in Industry and Software Development PDF Tisk Email
Napsal uživatel Pavel Vrecion   
Neděle, 23 Říjen 2011 12:09

Technical Documentation in Industry and Software Development

What is common and what is different

Pavel Vrecion

TD used in industrial design is far more complex and sophisticated than in other areas. In design process of machinery or electronics technical documentation is closely integrated not only into design process, but increasingly so in manufacturing, service and other processes.

If you will compare role of TD in software design, you will find many similarities, but also differences. Questions are:

  • What is common, and what differs?

  • Why so big difference exists?

  • What can software development learn form industry?

In software industry documentation is “nice to have”. Many argue that documentation is a must, but in reality there are excellent programs with terrible or even non existent documentation (especially open source) and vice versa.

Not so in industry. From the perspective of industrial company TD is a question of life and death. Stories of car giants like Toyota, GM and Fiat will explain why.
Aktualizováno Středa, 07 Prosinec 2011 11:35
Celý článek...
 
Doporučená četba PDF Tisk Email
Napsal uživatel Florian Nadge   
Neděle, 14 Červen 2009 20:29

  • The Elements of Style, William Strunk Jr. and E. B. White, Longman; 50 Anv edition, 2008: This is the classic reference book. It is a small booklet that is inexpensive.
  • The Chicago Manual of Style, Chicago, IL, University of Chicago Press, 2009: This often cited book is the authority when you need a reference on punctuation, capitalization, quotations, abbreviations, equations, etc.
  • Microsoft Manual of Style for Technical Publications, Microsoft Press, 2004 : The Microsoft Manual of Style for Technical Publications, Third Edition (MSTP) is the latest step in this direction and takes care of latest technologies and technical terms.
  • Read Me First! A Style Guide for the Computer Industry, 3 rd Edition, Sun Technical Publications, 2009: Clear content and consistent style are essential for the usability of any system. If you're  doing something complex, describing it simply becomes that much more important.
  • The Global English Style Guide: Writing Clear, Translatable Documentation for a Global Market,SAS Press, 2009: This detailed, example-driven guide illustrates how much you can do to make written texts more suitable for a global audience.
  • XML in Technical Communication, The Institute of Scientific & Technical Communicators, 2008 : This book describes the basics of XML syntax and terminology, the use of XML in technical communication and the advantages it can bring to the production of technical documentation.
 

 
Aktualizováno Pátek, 27 Listopad 2009 17:07