Editing Documentation (section)

== Documentation in computer science ==
{{main|Software documentation}}
=== Types ===
The following are typical software documentation types:
* [[Request for proposal]]
* [[Requirement|Requirements]]/[[statement of work]]/scope of work
* [[Software design]] and [[functional specification]]
* [[Systems design|System design]] and [[Functional specification|functional specifications]]
* [[Change management]], [[error]] and [[software feature|enhancement]] [[Tracking system|tracking]]
* [[User Acceptance Testing|User acceptance testing]]
* [[Man page|Manpages]]

The following are typical hardware and service documentation types:
* [[Computer network diagram|Network diagrams]]
* [[Network mapping|Network maps]]
* [[Datasheet]] for [[Information technology|IT systems]] ([[Server (computing)|server]], [[switch]], e.g.)
* [[Service catalog]] and [[Service Portfolio (ITIL)|service portfolio]] ([[ITIL|Information Technology Infrastructure Library]])

=== Software Documentation Folder (SDF) tool ===
A '''common type''' of software document written 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, Microsoft 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 workarounds. 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 tools for network inventory and configuration ===
These software tools can automatically collect data of your network equipment. The data could be for inventory and for configuration information. The [[ITIL|Information Technology Infrastructure Library]] requests to create such a database as a basis for all information for the IT responsible. It is also the basis for IT documentation. Examples include XIA Configuration.<ref>{{cite web |title=XIA Configuration Network Documentation Tool |url=https://www.centrel-solutions.com/xiaconfiguration/ |access-date=8 August 2017 |website=CENTREL Solutions}}</ref>