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 [...]

Tagged as: , , , , , , , , , , ,

Read the full article →

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, [...]

Tagged as: , , , , , , , , ,

Read the full article →

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 [...]

Tagged as: , , , , , , , , , ,

Read the full article →

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 [...]

Tagged as: , , , , , , , ,

Read the full article →

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 [...]

Tagged as: , , , , , , , , ,

Read the full article →

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, [...]

Tagged as: , , , , , , , , ,

Read the full article →

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.

Tagged as: , , , , , , , , , ,

Read the full article →

How to Document Business Rules Before Gathering Your Business Requirements

Post by Ivan Walsh. Follow me on Twitter. Why do we need to document Business Rules before starting to gather Business Requirements? Is there a connection between Business Requirements and Business Rules? One of the problems for Business Consultant is that they may focus so much on gathering Business Requirements, that they forget the underlying [...]

Tagged as: , , , ,

Read the full article →

Learn more about robots.txt from Matt Cutts

via mattcutts.com Posted via web from Technical Writing Tips

Read the full article →

Requirements Analysis – Part 9 Functional Requirements

Functional requirements explain what has to be done, and identified. The necessary task, action or activity that must be accomplished. Functional requirements analysis will be used as the top-level functions for functional analysis. Functional Requirements Excel spreadsheet Performance Requirements The extent to which a mission or function must be executed; generally measured in terms of [...]

Tagged as: , , , , , ,

Read the full article →

Requirements Analysis – Part 8 Types of Requirements

Requirements are categorized in several ways. The following are common categorizations of requirements that relate to technical management. The customers are those that perform the eight primary functions of systems engineering, with special emphasis on the operator as the key customer. Operational requirements will define the basic need and, at a minimum, answer the questions [...]

Tagged as: , , , ,

Read the full article →

Kate Winslet’s 7 Ways to Better User Guides

Post by Ivan Walsh. Follow me on Twitter. What can Kate Winslet teach you about proof-reading technical documents? Watch the movie The Reader and it will make sense. If she was writing this blog, she’d probably say: “Don’t do it all at once! One of the biggest mistakes you can make when revising any technical [...]

Tagged as: , , , , , , , ,

Read the full article →

Requirements Analysis – Part 7 Software Requirements Specification

A software requirements specification (SRS) is a complete description of the behavior of the system to be developed. It includes a set of use cases that describe all of the interactions that the users will have with the software. Use cases are also known as functional requirements. Functional Requirements Excel spreadsheet In addition to use [...]

Tagged as: , , , ,

Read the full article →

Requirements Analysis – Part 6 Use Cases

A use case is a technique for documenting the potential requirements of a new system or software change. Each use case provides one or more scenarios that convey how the system should interact with the end user or another system to achieve a specific business goal. Use cases typically avoid technical jargon, preferring instead the [...]

Tagged as: , , , ,

Read the full article →

Requirements Analysis – Part 5 Prototypes

Prototypes are mock-ups of an application. Mock-ups allow users to visualize an application that hasn’t yet been constructed. Prototypes help users get an idea of what the system will look like, and make it easier for users to make design decisions without waiting for the system to be built. Major improvements in communication between users [...]

Tagged as: , , , ,

Read the full article →