Describe the method of technical documentation, Software Engineering

Assignment Help:

Describe the method of Technical documentation

This usually comprises:

- Program listing/coding

-  Programming language(s) used 

- Algorithm/Flowchart

-  Purpose of system/program/software 

- Input formats

- Software requirements

- Hardware requirements

-  Minimum memory requirements  

-  known "bugs" in the system  

-  List of variables used (and their meaning/description)

- File structures

-  Sample runs (with results and actual test data used) 

- Output formats

- Validation rules

  • Install the hardware and, if required, the new software
  • Fully test new system once installed

 


Related Discussions:- Describe the method of technical documentation

List the pre-requisites for white-box testing, List the pre-requisites for ...

List the pre-requisites for white-box testing Pre-requisites for white-box testing are similar to black-box testing with one key difference: - During white-box testing, test

Path & Path Production, Path & Path Production, Syntax testing, Computer En...

Path & Path Production, Syntax testing, Computer Engineering Take the following flow graph and use the procedure in chapter 8 to derive an equivalent regular expression. Show all i

Describe the different types of frequency hoping, Question: (a) What i...

Question: (a) What is a piconet in a Bluetooth context? (b) Discuss the concept of Master, slave, stand-by and parked devices with respect to a Bluetooth piconet. (c)

What are the umbrella activities of a software process, What are the umbrel...

What are the umbrella activities of a software process? Software project tracking and control. Risk management. Formal Technical Reviews. Software Quality Assurance.

Explain capability maturity model, CAPABILITY MATURITY MODEL (CMM): CMM is...

CAPABILITY MATURITY MODEL (CMM): CMM is a strategy for recovering the software process, irrespective of the actual life cycle model used.

Draw E-R diagram for the given situation, Draw E-R diagram for the followin...

Draw E-R diagram for the following situation An account is a relationship between customer and bank. A customer has a name. A bank has a branch. A customer may have numerous ac

Explain code inspection, A manual [formal] testing [error detection] method...

A manual [formal] testing [error detection] method where the programmer reads source code, statement by statement, to a group who ask questions determined the program logic, determ

Different phases of the rational unified process, Problem: (a) Briefly...

Problem: (a) Briefly explain the different phases and workflows of the Rational Unified Process. (b) What are the two benefits that might be gained when using such a life-c

State lehman first law, State Lehman's First law A program that is used...

State Lehman's First law A program that is used in real world environment of necessity must change or become progressively less useful in that environment.

What is maintenance, Define maintenance. Maintenance is defined as the ...

Define maintenance. Maintenance is defined as the procedure in which changes are executed by either modifying the existing system's architecture or by adding new mechanism to t

Write Your Message!

Captcha
Free Assignment Quote

Assured A++ Grade

Get guaranteed satisfaction & time on delivery in every assignment order you paid with us! We ensure premium quality solution document along with free turntin report!

All rights reserved! Copyrights ©2019-2020 ExpertsMind IT Educational Pvt Ltd