1. DocOps: Iterating Toward an Agile-Integrated Continuous Publication Workflow
WriteTheDocs PDX
October 11, 2016
Andrew McCollough

2. Outline Why did we need to change our process? What was the problem?
A Dev/DocOps Aside
How were we doing it? How was it frustrating?
What did we iterate to?

3. Why? Perfect software needs no documentation
Our software needs documentation
QED

4. Create, Read in multiple formats, Update, and Delete Documentation for rapidly iterating software.
What is the Problem?

5. DevOps
DevOps emphasizes communication, collaboration and integration between software developers and IT operations while automating the process of software delivery and infrastructure changes.
Change in organizational methodology and tooling to enable continuous deployment of software.

6. DocOps
A highly-collaborative content creation process that allows product information to be continuously developed along with the software.

7. Principles Just Barely Good Enough Extreme Collaboration
Don’t Repeat Yourself
Compose Simple Tools

8. How Were We Doing It?

9. Well, we weren’t.

10. Document this SaaS
Workflow
Toolchain

11. JBGE…but good

12. Project Brief
Document the existing software platform workflows and UI.
Provide multiple outputs
High degree of accuracy on Regulatory information.
Multiple workflows, multiple jurisdictions.

13. Project Constraints Quality No Time No Resources High Quality
High Delta
Quality
Scope
Resources
Schedule
No Time
No Resources - Do it cheap with what you have
High Quality - Regulatory Compliance environment
High Delta - Rapidly evolving regulations and software

14. Iterative Improvement
Get it working
Test & Measure Efficacy
Improve it
Repeat
Series of short writing sprints to work toward a solution

15. Mistakes: First 3 iterations
Google Docs - image & source control nightmare
Google Docs - Export to publication nightmare
Wordpress Image Management - Just Nope
Wordpress Plugins + HTML - Hackey and fragile
Annotating in Photoshop - Slow, extra step.

16. Extreme Collaboration

17. Our DocOps Pipeline Regulatory SME Reg Briefs Priority Rank HTML
Marketing
Writers
Screencaps
Backlog
PDF
Sales
Editors
Write
Wordpress
Users
Data Science SME
images
Edit
Word Docx
Strategy
Product Team
User Workflows
Review
Consulting Team
Engineering Team
Target Markets
Publish
Customer Service
FAQ
Deploy
Customer Success
Sales Team
Executive Team

18. Dry and Composed

19. Fourth Iteration Jira - Kanban Wordpress - authoring
hypothes.is - feedback
AWS CDN - images
Nimbus - UI capture and annotation
Git & Mkdocs & Aerobatic & Markdown & Wordpress - Publication, Source Control, and deployment

20. Toolchain Breakdown

21. Jira
Tight collaboration with engineering

22. Markdown
Simple text-only that focuses on content over markup. Lightweight compared to DITA.

23. Source Control
Just gotta have it

24. Nimbus Screenshot
Quick, all-in-one screenshoting.

25. hypothes.is
Simple review, commenting, annotations

26. Push to multiple formats

27. AWS CDN

28. Review Just Barely Good Enough Extreme Collaboration DRY
Compose Simple Tools
But Good Enough
Transparent pipeline at every stage

29. Thank You

30. Resources [Jira](https://www.atlassian.com/software/jira)
[Github](
[Bitbucket](
[Pandoc](
[LaTeX](
[Markdown](
[Nimbus Screenshot](
[Hypothesis](
[AWS](
[Transmit](
[mkdocs](
[CA Technologies](
[CA](