Monday, July 28, 2008

Writing Spec documents

Here are some things to think about when you are writing a spec. Some of these items are technology dependent (this is really in reference to a spec for RoR)
  1. Make sure you understand the requirements. If you have any questions about what is being asked, make sure that you get them answered first. If you don't understand the requirement completely, you can not write the software. This is the most important part of writing the spec. Again, ask questions early and often. Do not assume.
  2. Content is much more important than format. If you are spending more than 10 minutes on the formatting it is too long. Just write stuff down that conveys what you are trying to accomplish.
A checklist of items that to think about when you are writing the spec
  • Screen additions, modifications
  • Url design / Route configuration
  • Database changes
  • Code
    • Controllers
    • Views
    • Models
  • Tests
    • Selenium
    • Spec

No comments: