Slide 1

Slide 1 text

Genry Leyva González @genrylg www.linkedin.com/in/genrylg [email protected] Ops Team at

Slide 2

Slide 2 text

DOCs as Code

Slide 3

Slide 3 text

User’s Manual Install Manual README Administration Manual Contribution Guide API Specification

Slide 4

Slide 4 text

No content

Slide 5

Slide 5 text

No content

Slide 6

Slide 6 text

 Poor Collaboration  Lack of versioning  Documentation at the end  Different cadence between release and doc  Developers not involved  Difficult to obtain different file formats

Slide 7

Slide 7 text

DOCs as Code 2007 2008 2009 … 2014 2015 2016 collaboration developers involved review & merge testing & publishing semantic versioning

Slide 8

Slide 8 text

Next In Progress … UAT Pending for Doc Being Documented Doc Ready Staging feature feature feature feature feature feature feature feature feature feature feature feature feature Documentation Stages

Slide 9

Slide 9 text

Next In Progress … Dev Done Pending for Doc Being Documented Doc Ready Staging feature feature feature feature feature feature feature feature feature STEP 1 STEP 2 STEP 3 STEP 4 STEP 5 feature feature feature feature Every feature is documented as part of a delivery process Definition of DONE

Slide 10

Slide 10 text

Create feature branch for a new feature / user story Write new or edit existing documentation Create pull request Automatic Testing Review Merge to the develop branch Regenerate documentation files Merge Trigger of CI plan to publish CREATION PROCESS

Slide 11

Slide 11 text

Branch by feature Git on Gitlab Continuous Integration

Slide 12

Slide 12 text

Semantic Versioning

Slide 13

Slide 13 text

lightweight markup language plain text formatting it can be converted to many formats

Slide 14

Slide 14 text

PANDOC IN: more than 20 OUT: more than 30 CLI

Slide 15

Slide 15 text

Doc Proyects in Gitlab

Slide 16

Slide 16 text

No content

Slide 17

Slide 17 text

 Simple way of writing documents  Collaboration  Writers have a similar workflow to developer

Slide 18

Slide 18 text

 Based on developers' infrastructure  Ops team as enablers  Documentation delivered along with a product

Slide 19

Slide 19 text

No content

Slide 20

Slide 20 text

genrylg genrylg DOCs as Code