The Cherryleaf Podcast

18. Docs Like Code - Interview with Anne Gentle


Listen Later

Interview with Anne Gentle, author of Docs Like Code and Product Manager at Cisco. 

Interview by Ellis Pratt, Cherryleaf

Become a better technical communicator by subscribing to the Cherryleaf newsletter

Cherryleaf training course – Advanced technical writing techniques

For comments and feedback: [email protected]

Topics covered: 

  • What is docs as code?
  • Why do it?
  • When might this approach might be applicable?
  • The limitations
  • Docs like code in development sprints
  • Is it only for developer docs?
  • Do you you need to understand programming?
  • Why did you self publish?
  • The benefits of taking this approach
  • The future developments
  • Automating document builds
  • Links to topics mentioned:

    https://www.docslikecode.com/

    Conversation and Community: The Social Web for Documentation

    Troy Howard Documentarian, Super Genius at Twitter

    http://codewerdz.org/ Repository analytics for code and docs

    Matt Fleming on Twitter

    Docs Like Code GitHub repository

    Jekyll

    https://docs.openstack.org/pike/

    WADL RAML OpenAPI

    https://bitbucket.org/

    http://docs.metacloud.com/

    Liquid scripting

    YAML

    PrinceXML

    Lunr Search Engine 

    Solr (Search Engine)

    Why we use a ‘docs as code’ approach for technical documentation Jen Lambourne, GDS, GOV.UK

    The Definition of Done

    Learn Python the Hard Way

    AsciiDoc

    ReST

    GitHub Flavoured Markdown spec

    XML Press

    REST API

    Building Docs Like Code - article

    Travis CI 

    Jenkins

    Circle CI

    Webhooks

    Bash scripts

    An Introduction to Static Site Generators

    GitHub Pages 

     

    ...more
    View all episodesView all episodes
    Download on the App Store

    The Cherryleaf PodcastBy Cherryleaf

    • 5
    • 5
    • 5
    • 5
    • 5

    5

    4 ratings