Practical Docs as Code by David Garcia

Share
Embed
  • Published on Oct 26, 2020
  • We all value good product docs, but writing them is another story. The pressure to launch the product does not leave you time for taking care of documentation. And when there is time, you don't feel productive since you know they might become outdated as soon as there is a new version of the software.

    In this workshop, I'll show you the techniques and tools I use to keep documentation projects current while enjoyable to maintain. We'll host the docs in GitHub near its source code, write them in RestructuredText, generate a beautiful site with Sphinx, use ReadTheDocs to automate the publication process, and Vale to test them.

    * Thank you David for recording it again as the recoding during the the actual session didn't capture his screen.
  • Science & TechnologyScience & Technology

Comments • 0