© Copyright 2016

IMPLEMENTING ISO/IEC 26515THE STANDARD FOR AGILE SOFTWARE DOCUMENTATION

KAI WEBER, LEAD TECHNICAL WRITER, SIMCORP

© Copyright 2016

WHO AM I AND WHAT DO I KNOW?

2

© Copyright 20163

BRINGING INTEGRATED SOLUTIONS TO INVESTMENT MANAGERS

THE WORLD’S LEADING PROVIDER

MORE THAN

170CLIENTSWORLDWIDE

MORE THAN

20%OF REVENUEINVESTED IN R&D

MORE THAN

20OFFICESGLOBALLY

MORE THAN

40YEARS OFDEVELOPMENT

MORE THAN

16,000USERS

© Copyright 2016© Copyright 2016

AGENDA

4

1. A funny thing happened on the way to agile The set-up

2. User documentation and agile The potential

3. Enter ISO/IEC 26515 The standard

4. The standard hits reality The mess

5. Revising the standard The future

© Copyright 2016

A FUNNY THING HAPPENED ON THE WAY TO AGILE

5

THE SET-UP

milindageorge.wordpress.com scaledagileframework.com

© Copyright 2016

A FUNNY THING HAPPENED ON THE WAY TO AGILE

6

THE SET-UP

scaledagileframework.comsunfrog.com

?

© Copyright 2016

A FUNNY THING HAPPENED ON THE WAY TO AGILE

7

THE SET-UP

sunfrog.com

© Copyright 2016

A FUNNY THING HAPPENED ON THE WAY TO AGILE

8

THE SET-UP

semaphore-software.comsunfrog.com

© Copyright 2016

USER DOCUMENTATION AND AGILE

9

THE POTENTIAL

The Agile Manifesto - a statement of values

• Individuals and interactions > Processes and tools

• Working software > Comprehensive documentation

• Customer collaboration > Contract negotiation

• Responding to change > Following a plan

Agile artefacts TC contributions & issues

Agile teams Advocate for users

Is doc task included?

Definition of Done Ensure usability & workflows

Is doc deliverable included?

User stories Draft task-oriented stories

Do they drive docs?

Sprints (none)

Is documentation in sync?

© Copyright 201610

THE STANDARD

ENTER ISO/IEC 26515

ISO/IEC 2651X Standards family in “Systems and software engineering” for user documentation:

• ISO/IEC 26511:2011 “Requirements for managers of user documentation”

• ISO/IEC 26512:2011 “Requirements for acquirers and suppliers of user documentation”

• ISO/IEC 26513:2009 “Requirements for testers and reviewers of user documentation”

• ISO/IEC 26514:2008 “Requirements for designers and developers of user documentation”

• ISO/IEC 26515:2011 “Developing user documentation in an agile environment”

© Copyright 201611

ENTER ISO/IEC 26515

© Copyright 201612

THE STANDARD

ENTER ISO/IEC 26515

ISO/IEC 26515:2011 “Developing user documentation in an agile environment”

From the introduction at https://www.iso.org/obp/ui/#iso:std:iso-iec-ieee:26515:ed-1:v2:en:

• "Although agile development methods often advocate less life cycle documentation, the users of a

software product still expect and require quality user documentation to be provided with these

software products."

• "This International Standard is independent of the agile development methods and tools that are

used to produce the software."

© Copyright 2016

ENTER ISO/IEC 26515

13

THE STANDARD

Tech comm’s are members of agile teams

• Create and edit user documentation

• Contribute to design, workflow, UX, test

• Offer feedback

• Train other team members

• Participate in scrum meetings

scrumexpert.com

© Copyright 2016

ENTER ISO/IEC 26515

14

THE STANDARD

User documentation is created in agile teams

• Plan, resource and track it in sprints

• Lives in agile artefacts (backlog, user stories)

• Test it along with development

• Demo it in a walkthrough

• Accept it with development*

* Indirectly related user documentation can be created before or

slightly after development

venturebeat.com

© Copyright 2016

ENTER ISO/IEC 26515

15

THE STANDARD

User documentation is created in agile teams

• Plan, resource and track it in sprints

• Lives in agile artefacts (backlog, user stories)

• Test it along with development

• Demo it in a walkthrough

• Accept it with development*

* Indirectly related user documentation can be created before or

slightly after development

Agile artefacts Tech comm issues

Agile teams Is doc task included?

Definition of Done Is doc deliverable included?

User stories Do they drive docs?

Sprints Is documentation in sync?

© Copyright 201616

THE MESS

THE STANDARD HITS REALITY

A different role raises questions for technical communicators:

• Headcount

• Skills

• Personality

• Approach

isoconsultingsolutions.com

© Copyright 201617

THE MESS

THE STANDARD HITS REALITY

A different process presents challenges to user documentation:

• Backlog

• User stories

• Environment

• Quality

magizbox.com

© Copyright 2016

REVISING THE STANDARD

18

THE FUTURE

Agile artefacts Tech comm issues

Agile teams Is doc task included?

Definition of Done Is doc deliverable included?

User stories Do they drive docs?

Sprints Is documentation in sync?

Currently suggested improvements

Adjusted documentation process phases to agile

Emphasised documentation as task, not role

Emphasised doc as part of "Done state"

Added DevOps for continuous doc delivery

aurorasblog.com

© Copyright 2016© Copyright 2016

Q & A

19

© Copyright 2016© Copyright 2016

LEGALDISCLAIMER

The contents of this presentation are for general

information and illustrative purposes only and are used at

the reader’s own risk. SimCorp uses all reasonable

endeavours to ensure the accuracy of the information.

However, SimCorp does not guarantee or warrant the

accuracy, completeness, factual correctness, or reliability

of any information in this publication and does not accept

liability for errors, omissions, inaccuracies, or typographical

errors.

The views and opinions expressed in this publication are

not necessarily those of SimCorp.

© 2016 SimCorp A/S. All rights reserved. Without limiting

rights under copyright, no part of this document may be

reproduced, stored in, or introduced into a retrieval system,

or transmitted in any form, by any means (electronic,

mechanical, photocopying, recording, or otherwise), or

for any purpose without the express written permission

of SimCorp A/S.

20