Writing a website technical specification template

Improve the clarity of technical writing, especially procedural writing Improve comprehension for people whose first language is not English Make human translation easier, faster and more cost effective Facilitate computer-assisted translation and machine translation Improve Reliability concerns of maintenance and assembly by reducing their probability to introduce defects However, these claims come mostly from those who have invested in developing it, implementing it or supporting it. In the absence of third-party endorsement or published scientific studies, such claims should be considered unconfirmed.

Writing a website technical specification template

What I have struggled to find, though, is a good, detailed description of what should actually go in an FS and, in particular, to what level of detail. Therefore, I present a specification for a functional specification. This my own view and by no means an industry standard, but it works for me.

What Document are We Talking About? This is the document that you: I just want to be sure we are all talking about the same thing. It might not be a single monolithic text-and-diagrams epic.

Such a specification is not generally appropriate for a system that is to be bought off the shelf. A Functional Specification of a computer system describes the externally-visible behaviour of that system.

writing a website technical specification template

That definition might sound a little too simple to be true. What is a System? I like to think of a computer system as a black box. The black box has two interesting features: There are two types of external entities — humans and other systems also collectively referred to as actors of the systemand we need to worry about them both.

State, which changes as a result of interactions with the actors. This simple definition applies to pretty much any system you can think of.

All systems have interfaces — without any interfaces, a system is just a rather uninteresting black box! Some systems do not have any system interfaces, but in these days of end-to-end integration, most systems do. Some very simple systems do not have any state, although most interesting systems do any system that manages data has state.

One of the most important things to get clear for a system under design is where the system boundary lies, and you can do that easily by identifying its interfaces with the outside world. I call this a context diagram. An example context diagram Two Key Elements — Functions and Data Armed with my definition of a system, I can now say that there are two key elements to a functional specification: Functions — a description of the interactions between the system and its human and system actors Data — a description of the state of the system Once you have described all the functions and all the data to the right level of detailyou are done — simple as that!

Describing Functions The functions of a system are the interactions that can occur between the system and its actors through the interfaces. An interaction is a sequence of actor inputs e.

Typically the actor is trying to achieve some objective log in, search for data, update data, perform a calculation etc. They are, to my mind, the perfect format for describing interactions between an actor and the system. Laura Brandenburg has a similar love affair with use cases. Note that the example use case shows interactions both with a human user and also an external system the single-sign on directory.

Rather, they are the anchor for the functions, around which the other details can be added. Adriana Beal has some additional comments on this topic in this article.

Functions — How Much Detail is Allowed? The tricky part is deciding how much detail to include either within the use cases or alongside them.

writing a website technical specification template

You are allowed to include full detail of any externally-visible behaviour of the system including behaviour through system interfaces.

You are not allowed to include any details on the internal workings of the system. For example, you are absolutely allowed to include:Download templates in either MS Office and Apple iWork format.

Instant download. day no questions asked money-back guarantee. Technical Specifications. The CDM is operational “out of the box.” Once you install the software and set up your web server and database server, you can access the front-end GUI administrative suite, which enables you to optimize settings without any need to modify the .

Our building product and material specifications are free to view and download in DOC, RTF or Text. These long-form proprietary CSI and CSC specifications are complete with technical data, astm standards, performance features and product attributes. Introduction. Software Requirement Specification (SRS) document usually contains a software vendor’s understanding of a customer’s software requirements.

Welcome to CPARS. CPARS hosts a suite of web-enabled applications that are used to document contractor and grantee performance information that is required by Federal Regulations. A well-crafted specification document allows designers and developers to move forward with a project while avoiding any surprises for the client down the line.

It should give a precise estimation for a timeline of the project, and a completion deadline.

10 Key Items on How to Write a Website Specification