Documentation: Difference between revisions

Content deleted Content added

Inline

Revision as of 08:20, 21 May 2014

Documentation is a set of documents provided on paper, or online, or on digital or analog media, such as audio tape or CDs. Example are user guides, white papers, on-line help, quick-reference guides. It is becoming less common to see paper (hard-copy) documentation. Documentation is distributed via websites, software products, and other on-line applications.

Professionals educated in this field are termed documentalists. This field changed its name to information science in 1968, but some uses of the term documentation still exists and there have been efforts to reintroduce the term documentation as a field of study.

Principles for producing documentation

While associated ISO standards are not easily available publicly, a guide from other sources for this topic may serve the purpose ^[1]^, ^[2]^,.^[3] David Berger has provided several principles of document writing, regarding the terms used, procedure numbering and even lengths of sentences, etc.^[4]

Guidelines

The following is a list of guides dealing with each specific field and type:

documentation in health care ^[5]
thesis writing [6], [7], [8]
papers for academic journal publishing (i.e. Journal of Food Science ^[9] and Analytical Chemistry ^[10])

Procedures and techniques

The procedures of documentation vary from one sector, or one type, to another. In general, these may involve document drafting, formatting, submitting, reviewing, approving, distributing, repositing and tracking, etc., and are convened by associated SOPs in a regulatory industry ^[11]^, ^[12]^, ^[13]^,.^[14]

Producing documentation

Technical writers and corporate communicators are professionals whose field and work is documentation. Ideally, technical writers have a background in both the subject matter and also in writing and managing content (information architecture). Technical writers more commonly collaborate with subject matter experts (SMEs), such as engineers, medical professionals, or other types of clients to define and then create content (documentation) that meets the user's needs. Corporate communications includes other types of written documentation that is required for most companies.

Specializing documentation

Marketing Communications (MarCom): MarCom writers endeavor to convey the company's value proposition through a variety of print, electronic, and social media. This area of corporate writing is often engaged in responding to proposals.
Technical Communication (TechCom): Technical writers document a company's project or service. Technical publication include user guides, installation manuals, and troubleshooting/repair/replace procedures.
Legal Writing: This type of documentation is often prepared by attorneys or paralegals who could be in private practice or retained as corporate council.
Compliance documentation: This type of documentation codifies Standard Operating Procedures (SOPs), for any regulatory compliance needs, as for safety approval, taxation, financing, technical approval, etc.

Indexing

Documentation in computer science

The following are typical software documentation types

Request for Proposal (RFP)
Requirements/ Statement of work/ Scope of Work (SOW)
Software Design and Functional Specification
System Design and Functional Specifications
Change Management, Error and Enhancement Tracking
User Test and Acceptance (UTA)

The following are typical hardware and service documentation types

network diagrams
network maps
datasheet for IT systems (Server, Switch, e.g.)
Service Catalog and Service Portfolio (ITIL)

Documentation include such as feasibility report, technical documentation, operational documentation, log book and etc.

Tools for documenting software

There are many types of software and applications used to create documentation.

SOFTWARE DOCUMENTATION FOLDER (SDF) A common type of software document written by software engineers in the simulation industry is the SDF. When developing software for a simulator, which can range from embedded avionics devices to 3D terrain databases by way of full motion control systems, the engineer keeps a notebook detailing the development "the build" of the project or module. The document can be a wiki page, MS word document or other environment. They should contain a requirements section, an interface section to detail the communication interface of the software. Often a notes section is used to detail the proof of concept, and then track errors and enhancements. Finally, a testing section to document how the software was tested. This documents conformance to the client's requirements. The result is a detailed description of how the software is designed, how to build and install the software on the target device, and any known defects and work-arounds. This build document enables future developers and maintainers to come up to speed on the software in a timely manner, and also provides a roadmap to modifying code or searching for bugs.

SOFTWARE FOR NETWORK INVENTORY AND CONFIGURATION (CMDB) These software tools can automaticly collect data of your network equipment. The data could be for inventory and for configuration information. The ITIL Library requests to create such a database as a basis for all information for the IT responsible. It's also the basis for IT documentation.

Documentation in criminal justice

"Documentation" is the preferred term for the process of populating criminal databases. Examples include the National Counterterrorism Center's Terrorist Identities Datamart Environment ("TIDE"), sex offender registries, and gang databases.^[15]

Notes

^ N/A (2003). "Guide to Documentation" (PDF). Retrieved 12 June 2009. ^{[dead link]}
^ CGRP. "A Guide to Documentation Styles" (PDF). Retrieved 12 June 2009.
^ N/A. "A guide to MLA documentation" (PDF). Retrieved 12 June 2009. ^{[dead link]}
^ Berger, David. "Procedures and Documentation" (PDF). Retrieved 15 June 2009.
^ Springhouse. Complete Guide to Documentation. Retrieved 12 June 2009.
^ Tampere University of Technology. "Thesis Writing at the Tampere University of Technology" (PDF). Retrieved 12 June 2009.
^ Faculty of Veterinary Medicine, University of Prince Edward Island. "A Guide for the Writing of Graduate Theses" (PDF). Retrieved 12 June 2009.
^ University of Waikato. "Writing and Submitting a Dissertation or Thesis at the University of Waikato" (PDF). Retrieved 12 June 2009.
^ Journal of Food Science. "Manuscript Submission". Retrieved 12 June 2009.
^ Analytical Chemistry. "Information for Authors". Retrieved 12 June 2009.
^ Cropper, Mark; Tony Dibbens (2002). "GAIA-RVS Documentation Procedures" (PDF). Retrieved 15 June 2009.
^ N/A. "GLNPO's Quality System Documentation Review Procedures and Tracking" (PDF). Retrieved 15 June 2009. ^{[dead link]}
^ UK Data Archive (2009). "Data Services Process Guides: Documentation Processing Procedures" (PDF). Retrieved 15 June 2009.
^ UK Data Archive (2007). "Data Services Process Guides: Documentation Processing Techniques" (PDF). Retrieved 15 June 2009. ^{[dead link]}
^ Rader Brown, Rebecca (2009). "The Gang's All Here: Evaluating the Need for a National Gang Database". Columbia Journal of Law and Social Problems. 42: 293–333.

External links

IEEE Professional Communication Society
Documentation Definition by The Linux Information Project (LINFO)
Information & Documentation List of selected tools

Library of articles on documentation: Technical writing and documentation articles

[agd-1] N/A (2003). "Guide to Documentation" (PDF). Retrieved 12 June 2009. ^{[dead link]}

[agds-2] CGRP. "A Guide to Documentation Styles" (PDF). Retrieved 12 June 2009.

[agmd-3] N/A. "A guide to MLA documentation" (PDF). Retrieved 12 June 2009. ^{[dead link]}

[pad-4] Berger, David. "Procedures and Documentation" (PDF). Retrieved 15 June 2009.

[cgd2-5] Springhouse. Complete Guide to Documentation. Retrieved 12 June 2009.

[twtu-6] Tampere University of Technology. "Thesis Writing at the Tampere University of Technology" (PDF). Retrieved 12 June 2009.

[gwgt-7] Faculty of Veterinary Medicine, University of Prince Edward Island. "A Guide for the Writing of Graduate Theses" (PDF). Retrieved 12 June 2009.

[wsdt-8] University of Waikato. "Writing and Submitting a Dissertation or Thesis at the University of Waikato" (PDF). Retrieved 12 June 2009.

[js-9] Journal of Food Science. "Manuscript Submission". Retrieved 12 June 2009.

[ifa-10] Analytical Chemistry. "Information for Authors". Retrieved 12 June 2009.

[grdp-11] Cropper, Mark; Tony Dibbens (2002). "GAIA-RVS Documentation Procedures" (PDF). Retrieved 15 June 2009.

[gqsd-12] N/A. "GLNPO's Quality System Documentation Review Procedures and Tracking" (PDF). Retrieved 15 June 2009. ^{[dead link]}

[dspg-13] UK Data Archive (2009). "Data Services Process Guides: Documentation Processing Procedures" (PDF). Retrieved 15 June 2009.

[dspg2-14] UK Data Archive (2007). "Data Services Process Guides: Documentation Processing Techniques" (PDF). Retrieved 15 June 2009. ^{[dead link]}

[15] Rader Brown, Rebecca (2009). "The Gang's All Here: Evaluating the Need for a National Gang Database". Columbia Journal of Law and Social Problems. 42: 293–333.

[1]

[2]

[3]

[4]

[5]

[6]

[7]

[8]

[9]

[10]

[11]

[12]

[13]

[14]

[15]

@@ Line 201: / Line 201: @@
 == Documentation in computer science ==
 {{main|Software documentation}}
-The following are typical documentation types
+The following are typical software documentation types
 * Request for Proposal ([[RFP]])
 * Requirements/ [[Statement of work]]/ Scope of Work (SOW)
@@ Line 208: / Line 208: @@
 * Change Management, Error and Enhancement Tracking
 * User Test and Acceptance ([[User Test and Acceptance|UTA]])
+The following are typical hardware and service documentation types
+* [[Computer network diagram|network diagrams]]
+* network maps
+* [[datasheet]] for IT systems (Server, Switch, e.g.)
+* Service Catalog and Service Portfolio ([[Information_Technology_Infrastructure_Library|ITIL]])
 Documentation include such as feasibility report, technical documentation, operational documentation, log book and etc.
@@ Line 215: / Line 222: @@
 SOFTWARE DOCUMENTATION FOLDER (SDF)
 A common type of software document written by software engineers in the simulation industry is the SDF. When developing software for a simulator, which can range from embedded avionics devices to 3D terrain databases by way of full motion control systems, the engineer keeps a notebook detailing the development "the build" of the project or module. The document can be a wiki page, MS word document or other environment.  They should contain a ''requirements'' section, an ''interface'' section to detail the communication interface of the software.  Often a ''notes'' section is used to detail the proof of concept, and then track errors and enhancements. Finally, a ''testing'' section to document how the software was tested.  This documents conformance to the client's requirements. The result is a detailed description of how the software is designed, how to build and install the software on the target device, and any known defects and work-arounds. This build document enables future developers and maintainers to come up to speed on the software in a timely manner, and also provides a roadmap to modifying code or searching for bugs.
+SOFTWARE FOR NETWORK INVENTORY AND CONFIGURATION ([[CMDB]])
+These software tools can automaticly collect data of your network equipment. The data could be for inventory and for configuration information. The [[ITIL|ITIL Library]] requests to create such a database as a basis for all information for the IT responsible. It's also the basis for IT documentation.
 == Documentation in criminal justice ==