Writing tech docs like a hacker with Jekyll
Static site generators are a new breed of documentation tools that are much more common in engineering groups where developers contribute to the documentation.
Jekyll is one of the most popular static site generators, but it is highly similar to others in the same category such as Docpad, Middleman, Wintersmith, and Octopress. You can see a more comprehensive list of the top static site generators at Staticgen.com.
Jekyll projects approach doc as code. All the files are open and editable within a code editor, and your files can live in the same repository as your program code or within the same version control workflow.
Although developers and web engineers love Jekyll, there are significant challenges to overcome when adopting Jekyll for any robust tech comm publishing scenario. Some of these challenges include conditional filtering, single sourcing, PDF output, a robust TOC, search, context-sensitive help, collaboration, SME review, and more.
In this presentation, Tom Johnson will share his adventures in using Jekyll and how he dealt with each of these challenges.
You can preview the slides here: idratherbewriting.com/files/jekyllwritetechdocslikehackerstc
When, Where, and Cost
- Date: Wednesday, January 18, 2017
- Time: 7:00 p.m.
- Where: location to be confirmed
- Cost: free
Please register using Meetup.
Presenter - Tom Johnson
Tom Johnson is a technical writer at Amazon Lab126 (www.lab126.com) in Sunnyvale, California. He is most well-known in the community for his tech comm blog at idratherbewriting.com. You can access the Jekyll documentation theme and other resources from the Jekyll tab on Tom's site. You can contact Tom through the following:
- Email: firstname.lastname@example.org
- Website: http://idratherbewriting.com
- Twitter: @tomjohnson
If you have any questions about this event, contact Greg Campbell, Program Manager, STC Southwestern Ontario Chapter.