Writing a design specification layout

detailed design document sample pdf

While in the past you got your marching orders from an employer that worked with clients or was itself in the software business, now all those responsibilities that were once distributed between expert-testing, program management, etc. You can't work by getting a few sentences of terse description over Skype and saying "See you in three months when I'm done.

Your doc is written to describe your solution and get feedback from your teammates.

Writing a design specification layout

Then address them preemptively. Again, try to walk through a user story to concretize this. You will get a very general idea of what the software is supposed to do, look like, and flow. For example, if your organisation has brand guidelines that should be adhered to, they should be included here. For extra brownie points, treat this design doc as a living document as you implement the design. Please leave a comment below if you have any questions or feedback! Your doc is written to describe your solution and get feedback from your teammates. At each stage, you must iterate your way closer to agreement. Do the Vacation Test If you go on a long vacation now with no internet access, can someone on your team read the doc and implement it as you intended? In your specification, outline any maintenance and support requirements that you have. What questions and doubts might you have about this design? Alternative Solutions What else did you consider when coming up with the solution above? Testability, Monitoring and Alerting I like including this section, because people often treat this as an afterthought or skip it all together, and it almost always comes back to bite them later when things break and they have no idea how or why. Before you start writing the code behind these illustrations, you should be able to answer all of those questions.

Browser and Device Support Websites can be viewed on a wide range of devices and browsers. The specification should be composed of simple, clear statements.

software design specification example pdf

Specification document should be simple Nobody needs to write a page specification from scratch. To help reviewers get a sense of the state of the world, include real numbers like of DB rows, of user errors, latency — and how these scale with usage. Alternative Solutions What else did you consider when coming up with the solution above?

If you are still reading, you believe in the importance of design docs. Screen dimensions are important too. You would spend days and weeks working on it.

functional design document template
Rated 7/10 based on 117 review
Download
Design specification