How to Structure a Software Design Document

A software design document is written to meet the following key objectives: Submit to the client for a review and sign off before proceeding to the next stage of project life cycle Facilitate development of efficient code by system developers Obtain review feedback from other designers and project managers Meet documentation requirements of the project Read more about How to Structure a Software Design Document[…]

How to Write Functional Requirements

A Functional Specifications Document (FSD) is produced after the requirements gathering sessions are complete and the Business Requirements Document (BRD) is signed off. The Functional Specifications Document serves as an input to: System designers for the design of the solution Developers for the solution build out during development Testers to enable them to test the Read more about How to Write Functional Requirements[…]

Technical Documents and their Technical Writers

Technical Documentation refers to documentation about a product. The information contained in these documents can be varied and can include product information, description of features, instructions on how to use a product and troubleshooting techniques. A Technical Writer is a professional who focuses on creating technical documentation such as user guides/manuals, system manuals, operating manuals Read more about Technical Documents and their Technical Writers[…]

How to Write a Useful User Guide

The objectives of producing a User Guide are: Help users get comfortable with the system Meet contractual obligations as a part of project execution Reduce software support requirements The starting point to writing the User Guide is to identify the target audience.  Prior to commencing work on the User Guide, it is important to familiarize Read more about How to Write a Useful User Guide[…]

Writing a Compelling Business Case

A Business Case should be written with sufficient detail in a language easily comprehended by the targeted audience to facilitate decision making. For many organizations, a compelling Business Case is a pre-requisite for committing investment into new projects and products. Business Cases also serve as a compelling argument to induce angel investors to fund ventures. Read more about Writing a Compelling Business Case[…]