Documentation

From Wikipedia, the free encyclopedia
Jump to navigation Jump to search
For other uses, see Documentation (disambiguation).
The multi-volume programmer's manual to a 1975 operating system called CB UNIX

Documentation is a set of documents provided on paper, or online, or on digital or analog media, such as audio tape or CDs. Examples 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[edit]

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[edit]

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

Procedures and techniques[edit]

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, reposting and tracking, etc., and are convened by associated SOPs in a regulatory industry. It could also involve creating content from scratch. Documentation should be easy to read and understand. If it's too long and too wordy, it may be misunderstood or ignored. Clear, Short, Familiar words should be used to a maximum of 15 words to a sentence. Only gender hyper neutral word should be used and cultural biases should be avoided. Procedures should be numbered when they are to be performed.[11], [12], [13],.[14]

Producing documentation[edit]

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, technical experts, 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[edit]

  • 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 product or service. Technical publication include user guides, installation an configuration 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[edit]

Documentation in computer science[edit]

Main article: Software documentation

The following are typical software documentation types

The following are typical hardware and service documentation types

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

Tools for documenting software[edit]

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 automatically 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. Examples include XIA Configuration[15].

Documentation in criminal justice[edit]

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

Documentation in Early Childhood Education[edit]

Documentation, as it pertains to the Early Childhood Education field, is "when we notice and value children's ideas, thinking, questions, and theories about the world and then collect traces of their work (drawings, photographs of the children in action, and transcripts of their words) to share with a wider community" [17]

Thusly, documentation is a process, used to link the educator's knowledge and learning of the child/children with the families, other collaborators, and even to the children themselves.

Documentation is an integral part of the cycle of inquiry - observing, reflecting, documenting, sharing and responding. [17]

Pedagogical documentation, in terms of the teacher documentation, is the "teacher's story of the movement in children's understanding". [17]According to Stephanie Cox Suarez in 'Documentation - Transforming our Perspectives', "teachers are considered researchers, and documentation is a research tool to support knowledge building among children and adults" [18]

Documentation can take many different styles in the classroom. The following exemplifies ways in which documentation can make the 'research', or learning, visible:

  1. Documentation Panels (bulletin-board-like presentation with multiple pictures and descriptions about the project or event).
  2. Daily Log (a log kept every day that records the play and learning in the classroom)
  3. Documentation developed by or with the children (when observing children during documentation, the child's lens of the observation is used in the actual documentation)
  4. Individual Portfolios (documentation used to track and highlight the development of each child)
  5. Electronic Documentation (using apps and devices to share documentation with families and collaborators)
  6. Transcripts or Recordings of Conversations (using recording in documentation can bring about deeper reflections for both the educator and the child)
  7. Learning Stories (a narrative used to "describe learning and help children see themselves as powerful learners" [17])
  8. The Classroom as Documentation (reflections and documentation of the physical environment of a classroom). [17]

Documentation is certainly a process in and of itself, and it is also a process within the educator. The following is the development of documentation as it progresses for and in the educator themselves:

  • Develop[s] habits of documentation
  • Become[s] comfortable with going public with recounting of activities
  • Develop[s] visual literacy skills
  • Conceptualize[s] the purpose of documentation as making learning styles visible, and
  • Share[s] visible theories for interpretation purposes and further design of curriculum. [19]

See also[edit]

Notes[edit]


External links[edit]

  1. ^ N/A (2003). "Guide to Documentation" (PDF). Archived from the original (PDF) on 29 July 2007.
  2. ^ CGRP. "A Guide to Documentation Styles" (PDF). Retrieved 12 June 2009.
  3. ^ N/A. "A guide to MLA documentation" (PDF). Archived from the original (PDF) on 2 September 2006. Retrieved 12 June 2009.
  4. ^ Berger, David. "Procedures and Documentation" (PDF). Archived from the original (PDF) on 27 July 2011. Retrieved 15 June 2009.
  5. ^ Springhouse (2008). Complete Guide to Documentation. ISBN 9781582555560. Retrieved 12 June 2009.
  6. ^ Tampere University of Technology. "Thesis Writing at the Tampere University of Technology" (PDF). Retrieved 12 June 2009.
  7. ^ Faculty of Veterinary Medicine, University of Prince Edward Island. "A Guide for the Writing of Graduate Theses" (PDF). Archived from the original (PDF) on 5 June 2011. Retrieved 12 June 2009.
  8. ^ University of Waikato. "Writing and Submitting a Dissertation or Thesis at the University of Waikato" (PDF). Archived from the original (PDF) on 9 December 2008. Retrieved 12 June 2009.
  9. ^ Journal of Food Science. "Manuscript Submission". Archived from the original on 25 May 2009. Retrieved 12 June 2009.
  10. ^ Analytical Chemistry. "Information for Authors". Retrieved 12 June 2009.
  11. ^ Cropper, Mark; Tony Dibbens (2002). "GAIA-RVS Documentation Procedures" (PDF). Archived from the original (PDF) on 2 November 2005. Retrieved 15 June 2009.
  12. ^ N/A. "GLNPO's Quality System Documentation Review Procedures and Tracking" (PDF). Archived from the original (PDF) on 4 December 2008. Retrieved 15 June 2009.
  13. ^ UK Data Archive (2009). "Data Services Process Guides: Documentation Processing Procedures" (PDF). Archived from the original (PDF) on 13 June 2010. Retrieved 15 June 2009.
  14. ^ UK Data Archive. "Data Services Process Guides: Documentation Processing Techniques" (PDF). Retrieved 15 June 2009.[dead link]
  15. ^ "XIA Configuration Network Documentation Tool". Retrieved 8 August 2017.
  16. ^ 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.
  17. ^ a b c d e Susan, Stacey (2015-05-11). Pedagogical documentation in early childhood : sharing children's learning and teachers' thinking. St. Paul, Minnesota. ISBN 9781605543925. OCLC 909907917.
  18. ^ "Documentation: Transforming our Perspectives | Project Zero". www.pz.harvard.edu. Retrieved 2018-10-26.
  19. ^ "ECRP. Vol 13 No 2". ecrp.uiuc.edu. Retrieved 2018-10-26.
Retrieved from "https://en.wikipedia.org/w/index.php?title=Documentation&oldid=881483523"