addressalign-toparrow-leftarrow-rightbackbellblockcalendarcameraccwcheckchevron-downchevron-leftchevron-rightchevron-small-downchevron-small-leftchevron-small-rightchevron-small-upchevron-upcircle-with-checkcircle-with-crosscircle-with-pluscontroller-playcrossdots-three-verticaleditemptyheartexporteye-with-lineeyefacebookfolderfullheartglobegmailgooglegroupshelp-with-circleimageimagesinstagramFill 1light-bulblinklocation-pinm-swarmSearchmailmessagesminusmoremuplabelShape 3 + Rectangle 1ShapeoutlookpersonJoin Group on CardStartprice-ribbonprintShapeShapeShapeShapeImported LayersImported LayersImported Layersshieldstartickettrashtriangle-downtriangle-uptwitteruserwarningyahoo

End-user documentation within a sprint

  • Jun 4, 2013 · 5:45 PM
  • This location is shown only to members

Agile and Scrum seems to be problematic for end-user documentation.  How are technical writers directly involved during the sprint so that user facing documents are ready to ship with the software at the end of the sprint period (documents such as installation, setup and configuration guides)?

 

1) How early in the agile software development process should technical writers get involved? Story Writing, Sprint Planning and Estimation, during the Sprint?

2) What collaboration tools are used to assist the team to ensure that documentation is always up to date?

3) How is the end-user documentation validated?

4) What labels are the final documents given? ie: are they published as docs for ‘Sprint nn’ or ‘Sprint nn of Release n’? What happens when, for example Sprint 26 overrides some of the information finalised in Sprint 19 documents?

5) What are best methods to merge sprint documentation?

6) How much documentation is just enough? Are screen shots of the GUI a good idea?

 

Join or login to comment.

  • Alyce K.

    What a great meetup! I had a fantastic time finding out what others are doing with documentation in Agile environments!
    Thanks to Sandy, Stuart and Atlassian.

    1 · June 6, 2013

  • Stuart

    Here is a good series of blog posts by one of Atlassian's tech writers about writing in an agile environment. http://blogs.atlassian.com/2009/08/technical_writing_in_agile_software_development_part_1/

    2 · June 5, 2013

  • James P.

    Thanks to Atlassian and attendees for a good meetup

    1 · June 5, 2013

  • A former member
    A former member

    Thanks for a great meetup; it was quite informative.

    June 5, 2013

  • Joshua L.

    It was great to hear approaches that others take when it comes to documentation.

    June 4, 2013

  • Joshua L.

    Great topic as I've always found that no-one wants to document. Will be great to see what is presented and discussed.

    May 27, 2013

  • James P.

    A meetup made just for me!

    May 27, 2013

Our Sponsors

  • ING Direct

    Kindly providing venue, food and drink at our primary ING Direct venue.

  • Scrum Australia

    Organisation of meetup events and materials for workshops.

  • Wargaming Sydney

    Pizza and drinks for workshops at the Wargaming Sydney studio.

People in this
Meetup are also in:

Sign up

Meetup members, Log in

By clicking "Sign up" or "Sign up using Facebook", you confirm that you accept our Terms of Service & Privacy Policy