agile technical writing - neo stcneostc.org/.../09/april2013_agiletechnicalwriting.pdf · agile...

AGILE TECHNICAL WRITINGTips for Surviving the Transformation

1Friday, April 12, 13

HISTORY LESSON

ExcavatorsArchitectsFramersMasonsPlumbersElectriciansForemanPainters

2Friday, April 12, 13

HISTORY LESSON

3

ArchitectsTestersAnalystsTech WritersManagersServer DevsClient DevsDatabase AdminsNetwork Admins

Friday, April 12, 13

SOFTWARE IS....

4Friday, April 12, 13

5

AGILE IN A NUTSHELL

Friday, April 12, 13

AGILE DISTILLED

Maximize ValueMaximize FeedbackEmbrace Change

6Friday, April 12, 13

WHOLE TEAM

Focused on ValueClear CommunicationT-Shaped PeoplePoly-pairingSwarming

7Friday, April 12, 13

8

FREQUENT RELEASES

Friday, April 12, 13

9

FREQUENT RELEASES

Friday, April 12, 13

9

FREQUENT RELEASESListen toUsers

Friday, April 12, 13

9

MaximizeFeedback

FREQUENT RELEASESListen toUsers

Friday, April 12, 13

9

MaximizeFeedback

FREQUENT RELEASESListen toUsers

ValidateAssumptions

Friday, April 12, 13

9

MaximizeFeedback

FREQUENT RELEASESListen toUsers

ValidateAssumptions

DiscoverFeatures

Friday, April 12, 13

9

MaximizeFeedback

FREQUENT RELEASESListen toUsers

ValidateAssumptions

DiscoverFeatures

Build Only What You Need

Friday, April 12, 13

9

MaximizeFeedback

FREQUENT RELEASESListen toUsers

No FearNo Stress

ValidateAssumptions

Build Confidence

DiscoverFeatures

Build Only What You Need

Friday, April 12, 13

ITERATIONS

10Friday, April 12, 13

11

SLICING AND DICING

Reduce Scope

Small, Imperfect, but Deliverable

12

11

Friday, April 12, 13

12

STANDUPS

Yesterday, Today, RoadblocksTimely information radiationActively work to address roadblocks

Friday, April 12, 13

SHOW AND TELL

13Friday, April 12, 13

RETROSPECTIVES

14

Regardless of what we discover, we understand and truly believe that everyone did the best job they could, given what they knew at the time, their skills and abilities, the resources available, and the situation at hand.

Friday, April 12, 13

15

STRATEGIES

Friday, April 12, 13

16

SIT WITH YOUR TEAM

Friday, April 12, 13

16

SIT WITH YOUR TEAM

Friday, April 12, 13

16

SIT WITH YOUR TEAM

Friday, April 12, 13

PAIRING

With EveryoneFirst UserCommunication Skills

Pairing Be assertive but cooperative Encourage new users to drive Use tools - pairing stations, projectors, collaborative software

17Friday, April 12, 13

DOCS ARE PART OF DONEDocumentation requirements are identified as part of the

project plan The development user story is not “done” until the

documentation is complete The product is not ready to release until documentation is

complete Documentation requirements are discussed at every stage of

planning Sprint 0 Sprint Planning Entry and Exit Meetings

18Friday, April 12, 13

19Friday, April 12, 13

CARVE OUT SOME “QUIET TIME”

20Friday, April 12, 13

GRADUAL ADOPTION

ExperimentTry something for an iterationBuild on success

21Friday, April 12, 13

MEASURE YOUR SUCCESS

Close Feedback Loops with UsersAssessment of Workflows and Strategies

22Friday, April 12, 13

WRITING STRATEGIES

80-20 RuleMinimalismContent ReuseSingle Sourcing

23

Become more efficient. Deliver “just enough” documentation.

Friday, April 12, 13

24

TOOLSTopic-based Authoring

DITA Author-it Online Help tools

Agile Project Management Tools Visual Media Board AgileZen Pivotal Tracker

Automated Publishing FrameScript DITA

Collaborative Authoring Google Drive Some newer DITA-based tools

Friday, April 12, 13

SUMMARY

25Friday, April 12, 13

THIS WORKS!

12% increase in productivity Incoming defects decreased substantially 100% of the users surveyed reported that accuracy and quality improved 100% of the users surveyed reported that satisfaction improved Morale and job satisfaction among technical writers increased Our reputation within the organization improved The need for more writers and more sophisticated tools gained c-level

attention

26

In the first six months, we noticed a few quick wins that continued to payoff moving forward.

Friday, April 12, 13

KEEP IT SIMPLE

Start SmallEmbrace FailureLean on each otherHave Fun

27Friday, April 12, 13

28

REFERENCES

The Agile Manifesto http://agilemanifesto.org/

Agile Principles http://agilemanifesto.org/principles.html

Tools DITA: https://www.oasis-open.org/committees/tc_home.php?

wg_abbrev=dita Author-it: http://www.author-it.com/ AgileZen: http://www.agilezen.com/ Pivotal Tracker: http://www.pivotaltracker.com/ FrameScript: http://www.framescript.com/

Friday, April 12, 13

THANK YOU!

Steve Jacksonsteve.jackson@leandog.com

Nicole Derrnicole.derr@gmail.com

Friday, April 12, 13