Building documentation for a web or mobile project the right way

Evan Kimbrell, Director at Sprintkick

Play Speed
  • 0.5x
  • 1x (Normal)
  • 1.25x
  • 1.5x
  • 2x
11 Lessons (1h 17m)
    • 1. Welcome to the class!

    • 2. First thing to do

    • 3. Creating an overview

    • 4. Creating a functions list

    • 5. Example of creating a functions list

    • 6. Adding pages

    • 7. Adding the user section

    • 8. Adding parameters

    • 9. Adding comments

    • 10. The class project

    • 11. Keep the learning going


About This Class

9/10 people who write specifications and documentations for their web or mobile projects do it wrong. They don't add enough detail, they forget crucial sections, or they use confusing standards resulting in unforeseen amounts of lost money, time, and human resources.

Don't be one of those people. Learn how to effectively document your projects so that all parties - not just developers and designers - can understand.

In this class, we're going to go over documentation and specifications. We're going to go from the Project Manager's viewpoint and tackle how to capture all of the relevant information from your project onto a set of pages.

We're going to cover the written aspect of documentation, but may I add that I highly suggest you learn how to add wireframes, which are just as important as the text itself.

What you'll learn:

  • What sections you need to include for any design or development project.
  • How to accurately put together an overview statement to get your team members on the same page.
  • How to list out and revise function lists.
  • How to tackle the task of listing pages and which areas are most commonly forgotten.
  • The correct way to comment and annotate.
  • Adding user personas and user goals as an addendum to your specs.
  • Adding parameters to tackle functions that need further explanation.

What you'll do:

At the end of the class, we'll work on creating custom documentation for your project (or any generic project you want to practice on). You'll follow the steps we followed in the class, post it to the group, and receive direct feedback. Remember: Practice makes perfect.