• Jordan BorthJordan Borth, almost 9 years ago

    Wilson Miner has has a pretty cool approach: http://dribbble.com/shots/1205599-Baby-Log-Spec/attachments/160426

    I'm super interested in this stuff as well. I've tried many approaches but none meet The Perfect Spec™ as I so desire as well. I'm working on an implementation/spec doc now for an upcoming Mac app we're building and am using Sketch to layout, show dimensions/spacing, etc. I'll post when it's further along.

    Thanks for starting the discussion, hopefully we can get some good examples. How are you currently formatting and arranging your docs, Allan?

    1 point
    • Allan GrinshteinAllan Grinshtein, almost 9 years ago (edited almost 9 years ago )

      Everyone involved in the project hammers on the same document. We use a wiki in GitHub that's basically formatted as such:

      Project Name

      Project summary

      Goals

      Goals and reasoning

      Requirements

      • Task -- Why
      • Task -- Why
      • Task -- Why

      Implementation details

      • High-level task -- Link to mockups -- Link to GitHub issue
      • High-level task -- Link to mockups -- Link to GitHub issue
      • High-level task -- Link to mockups -- Link to GitHub issue
      1 point
      • Nikhil NNikhil N, almost 9 years ago

        That's a neat template, Allan. Definitely and shamelessly going to copy this one. wink

        I'm curious about how do you'll keep a track of who added/modified what? Or does that quickly become irrelevant as you'll start working on the tasks?

        0 points
    • Nikhil NNikhil N, almost 9 years ago

      That's an incredible example.

      But to think of it, such docs would only be created upon finalising the window (as in this case), right? To do it with every change would be awfully exhausting.

      0 points