Monthly Archives: November 2010

10 More Capitalization Rules for Titles & Headings

Ever wondered if it’s ok to cap a letter in the middle of a document title? There are many golden rules in grammar and when to use capitals is one area where most of us trip up at some point. Last week, we looked at the most basic grammar mistakes you can make when using […]

Peer Review for System Requirements Specifications

A few weeks ago, we looked at Peer Reviews for Software Development LifeCycle projects. This week, we’re going to look at what you need to include when doing Peer Review for System Requirements Specifications. Reviewing System Requirements Specifications You can use the same free template we shared last time – email me if you don’t […]

Software Development Lifecycle Templates By Phase (MS Word/Excel)

Download MS Word templates for every phase of the Software Development Lifecycle. Ever wondered what technical documents you need to write for the Software Development LifeCycle? This free Excel spreadsheet identifies all the plans, guides and forms you to create such as those for requirements specification, design, implementation, testing, deployment, and post-deployment maintenance and enhancement. […]

40 Ways To Cost Your Next Software Technical Documentation

How much does it cost to write a user guide? One way to estimate the price is to ask your customer about the software project and gather the technical and user requirements. Once you have this, you can determine how long the project will take, what resources are required and who needs to be involved […]

5 Golden Rules of Capitalization in Software Documentation

How do you spell Yahoo? Most of us spell it like we say it, which is wrong… It’s Yahoo! not Yahoo. Why is this important? From one angle, it isn’t but if you want your documents to look professional, then you need to understand when and where to capitalize words. Where to start with Capitalization […]

How to Write Functional Specifications Documents

If you’re looking for ways to write your first Functional Specifications Documents, then the following tutorial will help. One way to develop Functional Specifications is to use free Microsoft Word templates from the web and modify different chapters or buy professional template sets with pre-formatted samples. What are Functional Specifications Documents? Functional Specifications Documents (also […]

Lessons Learned Template for Software Development Projects

Ever notice that you keep making the same mistakes in your Software Development projects? One way to improve the development process is to created a Lessons Learned Template, preferably in Microsoft Word, and use this to share the lessons you learned during the Software Development LifeCycle. Why Capture Lessons Learned? You learn from your mistakes, […]

9 Ways to Create Software Deployment Plans

Why do you need a Deployment Plan? The deployment process involves several inter-locking activities which can occur at the client or developers site or sometimes both. As every software system is different, you need to create technical documents that capture the processes and procedures within each activity as carefully as possible. You can use free […]

11 Ways To Improve Peer Reviews for Software Development Projects

At the end of each phase of the Software Development LifeCycle, we arrange a peer review. You can use this free peer review template to get started and ensure that your team benefits for having their code, documents and deliverables checked by more experienced developers, writers and testers. Peer Reviews Format & Guidelines If you […]

Ultimate Guide to Creating Naming Conventions for Technical Documents

Yesterday we looked at how to create the first steps in your Document Control Procedure. We identified the team members and their roles during the documentation process. The next step is to create a naming convention that you can use across all documents during the Software Development LifeCycle. Documentation Naming Convention Guidelines Common document elements […]

Document Control Procedure Template – Defining Roles & Responsibilities

If you’re looking for a free template to capture your Document Control Procedures, then use these guidelines to get started. You can use this format to capture different aspects of the document control procedure in the Software Development LifeCycle. Introduction Identify the team responsible for improve the quality of documentation delivered by developers, testers, consultants, […]

Deliverable Product Description Template & Sample Guidelines

If you’re looking for ways to document your Deliverable Product Description, then you can use this template. This document is used during the Software Development LifeCycle when you need to define the requirements for each deliverable. This free template helps you define the scope of work for this part of the development process and ties in with other technical documents.