Wikimedia Incubator

Template:Wp/brx/सांग्रां सुजुनुथाइ


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

Template:Expand section Template:Further

Documentation in computer science

edit

Template:Main 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 Acceptance Testing

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.

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.[15]

See also

edit

Template:Col-begin Template:Col-3

Template:Col-3

Template:Col-3

Template:Col-end

Notes

edit
  1. ↑ Template:Cite web
  2. ↑ Template:Cite web
  3. ↑ Template:Cite web
  4. ↑ Template:Cite web
  5. ↑ Template:Cite book
  6. ↑ Template:Cite web
  7. ↑ Template:Cite web
  8. ↑ Template:Cite web
  9. ↑ Template:Cite web
  10. ↑ Template:Cite web
  11. ↑ Template:Cite web
  12. ↑ Template:Cite webTemplate:Dead linkTemplate:Cbignore
  13. ↑ Template:Cite web
  14. ↑ Template:Cite webTemplate:Dead linkTemplate:Cbignore
  15. ↑ Template:Cite journal
edit

Template:Wiktionary

Template:Use dmy dates

Template:Authority control

Retrieved from "https://incubator.wikimedia.org/w/index.php?title=Template:Wp/brx/सांग्रां_सुजुनुथाइ&oldid=3914025"