SitePoint Sponsor

User Tag List

Results 1 to 4 of 4
  1. #1
    SitePoint Enthusiast
    Join Date
    Jan 2010
    Location
    Cambridge, UK
    Posts
    30
    Mentioned
    0 Post(s)
    Tagged
    0 Thread(s)

    Writing Specifications from Developer Perspective

    Hi,

    I've been asked by my boss to write a specification for a new application module, which is alien territory for me. I'm usually given specs to work from by others, but the way they approach it goes against how I initially plan an application. I tend prototype and write notes about the application as I go along. They're more technical too, dealing with specific functional elements (validation, error handling, etc).

    How do other developers tend to approach specifications? My boss needs an idea of how the application will work, so would it be considered a spec or a pitch?

    I'm dealing with PHP programming language, although I'd appreciate any advice regardless of background.

    Many thanks in advance

  2. #2
    Beer drinker Srirangan's Avatar
    Join Date
    Jan 2005
    Location
    Beerland!
    Posts
    776
    Mentioned
    0 Post(s)
    Tagged
    0 Thread(s)
    I like to work with User Stories.

    My idea is to keep things simple that even a lay man would understand, unless of course domain related business logic that only we know about needs to be implemented.
    Online Startups Insight for new entrepreneurs

  3. #3
    SitePoint Wizard silver trophy kyberfabrikken's Avatar
    Join Date
    Jun 2004
    Location
    Copenhagen, Denmark
    Posts
    6,157
    Mentioned
    0 Post(s)
    Tagged
    0 Thread(s)
    Second that. User stories, whatever format you present them in, is usually the best form of specification you can make.

  4. #4
    SitePoint Member
    Join Date
    Nov 2009
    Posts
    3
    Mentioned
    0 Post(s)
    Tagged
    0 Thread(s)
    It depends if your boss is looking for a _functional_ or _technical_ specification.

    A functional spec describes how something will work from an end user perspective. I like to use PowerPoint to create mockups with little embedded notes. A picture is worth 1000 words.

    A technical spec describes how a feature will work internally, and is usually written for programmers. This will include API documentation and implementation notes.

    As other have mentioned, user stories and other Agile practices should be used in conjuction with some minimal documentation.
    Jason M. Hanley, B.Math, MBA, PMP
    Owner, Syllogistic Software Inc.
    Creator, BuyMyStuff.com and Learn PHP Tutorial


Bookmarks

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •