In all Fortune 500 companies you are required to write software specifications documents. Even when not a process obligation, writing specs is a good practice according to Joelonsoftware.

But it’s usually time consuming. There are some heavy-weighted $$$$ softwares from IBM, Borland and others which can do so, but they are anti-productivity softwares.

Thanks to Rebol’s little gemware Makedoc2, you can write specs the agile way just using a simple notepad.

For example, you could write a spec like this one below (replace the generic parts with your own custom words for example replace by “My Super Projet”) with a simple notepad (see simple example here):

Software Requirements Specification for <%ProjectName%>

	Version 1.0 approved
	<%AuthorName%> - <%organization%> - <%date%>

History:

\table

Name

Date

Reason for change

Version

=row

<%authorname1%>

<%date1%>

<%reason-for-change1%>

<%version1%>

=row

<%authorname2%>

<%date2%>

<%reason-for-change2%>

<%version2%>

/table

===Introduction

---Purpose

<%{the product whose software requirements are specified in this document, including the revision or release number. Describe the scope of the product that is covered by this SRS, particularly if this SRS describes only part of the system or a single subsystem.}%>

---Project Scope

<%{Provide a short description of the software being specified and its purpose, including relevant benefits, objectives, and goals. Relate the software to corporate goals or business strategies. If a separate vision and scope document is available, refer to it rather than duplicating its contents here. An SRS that specifies the next release of an evolving product should contain its own scope statement as a subset of the long-term strategic product vision.}%>

===Overall Description

---Product Perspective

<%{Describe the context and origin of the product being specified in this SRS. For example, state whether this product is a follow-on member of a product family, a replacement for certain existing systems, or a new, self-contained product. If the SRS defines a component of a larger system, relate the requirements of the larger system to the functionality of this software and identify interfaces between the two. A simple diagram that shows the major components of the overall system, subsystem interconnections, and external interfaces can be helpful.}%>

---Product Features

<%{Summarize the major features the product contains or the significant functions that it performs or lets the user perform. Details will be provided in Section 3, so only a high level summary  is needed here. Organize the functions to make them understandable to any reader of the SRS. A picture of the major groups of related requirements and how they relate, such as a top level data flow diagram or a class diagram, is often effective.}%>

* Feature 1

* Feature 2

===System Features

<%{This template illustrates organizing the functional requirements for the product by system features, the major services provided by the product. You may prefer to organize this section by use case, mode of operation, user class, object class, functional hierarchy, or combinations of these, whatever makes the most logical sense for your product.}%>

---System Feature 1

<%{Don’t really say “System Feature 1.” State the feature name in just a few words.}%>

+++Description and Priority



+++Stimulus/Response Sequences

<%{List the sequences of user actions and system responses that stimulate the behavior defined for this feature. These will correspond to the dialog elements associated with use cases.}%>

#Step 1

#Step 2

#>Step 2.1

#>Step 2.2

#>>Step 2.2.1		

=image images/sequenceDiagramBasicCourse.jpg

After saving, run makedoc2.r (.r extension should be associated with Rebol) which will let you choose the file above in a file dialog. Confirm and the html document below will be generated (nothing will prevent you to copy and paste in a document afterwards):

In some next article, I’ll show you some advanced tips for generating specs with Makedoc2.

Update: for software design template see for example this one.

0 people like this post.

Like 

<!-- Social Bookmarks BEGIN -->

Bookmark this

<!-- Social Bookmarks END -->