a) System Requirements Specification
b) System Design Specification
c) Test Document
d) User Manual
Documentation:
Common types of computer hardware/software documentation include online help, FAQs, how-tos, and user guides. The term RTFM is often used colloquially in regard to such documentation, especially to computer hardware and software user guides.
A common type of software document frequently written by software engineers in the simulation industry is the SDF (software documentation folder). While developing the software for a simulator, which can range from embedded avionics devices to 3D terrain databases to full motion control systems, the engineer keeps a notebook detailing the development lifecycle of the project. The notebook can contain a requirements section, an interface section detailing the communication interface of the software, a notes section to detail the proof of concept attempts to track what worked or didn't work in solving certain problems, and a testing section to detail how the software will be tested to prove conformance to the requirements of the contract. The end 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 weaknesses in the design of the software. This document will allow future developers and maintainers of the trainer to come up to speed on the software design in as short a time as possible and have a documented reference when modifying code or searching for bugs.
In addition, many software products include an online version of the documentation that you can display on your screen or print out on a printer. A special type of online documentation is a help system , which has the documentation embedded into the program. Help systems are often called context-sensitive because they display different information depending on the user's position (context) in the application.
Subfields of documentation includes:
- Scientific documentation
- Technical documentation
- Legal documentation
- Administrative documentation
- Historical documentation
A System Requirements Specification A structured collection of information that embodies the requirements of the system.
A Business analyst (BA), sometimes titled System analyst, is responsible for analysing the business needs of their clients and stakeholders to help identify business problems and propose solutions. Within the systems development life cycle domain, the BA typically performs a liaison function between the business side of an enterprise and the information technology department or external service providers.