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


HISTORY LESSON

3

ArchitectsTestersAnalystsTech WritersManagersServer DevsClient DevsDatabase AdminsNetwork Admins

Friday, April 12, 13

SOFTWARE IS....


5

AGILE IN A NUTSHELL


AGILE DISTILLED

Maximize ValueMaximize FeedbackEmbrace Change


WHOLE TEAM

Focused on ValueClear CommunicationT-Shaped PeoplePoly-pairingSwarming


8

FREQUENT RELEASES


9

FREQUENT RELEASES


9

FREQUENT RELEASESListen toUsers


9

MaximizeFeedback



9

MaximizeFeedback


ValidateAssumptions


9

MaximizeFeedback


ValidateAssumptions

DiscoverFeatures


9

MaximizeFeedback


ValidateAssumptions

DiscoverFeatures

Build Only What You Need


9

MaximizeFeedback


No FearNo Stress

ValidateAssumptions

Build Confidence

DiscoverFeatures

Build Only What You Need


ITERATIONS


11

SLICING AND DICING

Reduce Scope

Small, Imperfect, but Deliverable

12

11


12

STANDUPS

Yesterday, Today, RoadblocksTimely information radiationActively work to address roadblocks


SHOW AND TELL


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.


15

STRATEGIES


16

SIT WITH YOUR TEAM


PAIRING

With EveryoneFirst UserCommunication Skills

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


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


CARVE OUT SOME “QUIET TIME”


GRADUAL ADOPTION

ExperimentTry something for an iterationBuild on success


MEASURE YOUR SUCCESS

Close Feedback Loops with UsersAssessment of Workflows and Strategies


WRITING STRATEGIES

80-20 RuleMinimalismContent ReuseSingle Sourcing

23

Become more efficient. Deliver “just enough” documentation.


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


SUMMARY


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.


KEEP IT SIMPLE

Start SmallEmbrace FailureLean on each otherHave Fun


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/


http://agilemanifesto.org/






http://www.author-it.com/

http://www.author-it.com/

http://www.agilezen.com/

http://www.agilezen.com/

http://www.pivotaltracker.com/

http://www.pivotaltracker.com/

http://www.framescript.com

http://www.framescript.com

THANK YOU!

Steve [email protected]

Nicole [email protected]


mailto:[email protected]




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

Documents