Sep 1, 2012 Ξ Comments are off

Reading source documents

posted by Tenneti

This section enumerates the different source documents and explains the ways to retrieve required information from them.

Source documents include functional specifications, system requirements specifications, technical design specifications, architecture documents, troubleshooting documents, and other design documents. These documents act as the basic plan for the developer to build the application. Hence, these are a good starting point from the documentation point of view as well.

You may not always get all the required information from the source documents. They may contain information irrelevant to the end user. You need to read such information and analyze the impact on the end user. Hence, the basic tasks you must perform include:

  • •Studying and discerning the available information
  • •Identifying gaps and problem areas
  • •Making notes and establishing relationships
  • •Listing down questions for the subject matter experts

Types of source documents

There are different types of source documents that are available. The product development team, the quality assurance team, and the technical publications team depend upon the source document to plan, schedule, and execute their work. Hence, these source documents act as a reference point for all the parties involved in the product development during its various stages.
The common types of source documents are as follows:

  1. Design Documents
  2. Requirements Specifications
  3. Architecture Documents
  4. Use Cases

As stated earlier, these documents act as a reference for different teams. Hence, you need to be adept in the information provided in these documents.

Share This

Comments are closed.

Log in with:

Subscribe to our Newsletter

To subscribe to Techitive newsletter simply add your email below. A confirmation email will be sent to you!



Understanding Source Documents – E-Book

Understanding Source Documents - E-Book

July 24th, 2013

Techitive Press presents the second E-Book for ready reference - Understanding Source Documents. [...]

E-Book – Technical Writing Process – An Overview

E-Book - Technical Writing Process - An Overview

July 15th, 2013

Techitive Press presents small E-Books for ready reference. [...]

Understanding articles

Understanding articles

September 22nd, 2012


Self Review Checklist

Self Review Checklist

September 16th, 2012

Grammar Verify the text for spelling mistakes and typographical errors. Verify the text fo[...]

Search on Techitive

Subscribe on Facebook