Leon Barnard from Balsamiq wrote up a great series of challenges and solutions for the docslikecode.com website. His lessons learned are super helpful for all of us:
- Challenge #1: Documenting multiple product versions
- Challenge #2: Adding play/pause to animated GIFs
- Challenge #3: Giving the list pages a makeover
He summarizes the series best in his own words:
Static sites may seem to have more limitations than traditional CMSs or powerful technical writing tools. But if you can find a way around the limitations, you can reap the benefits that made static sites attractive in the first place. Markdown is easy. GitHub offers collaborative coding. A scripted robot can run a build command from a terminal. It’s writing excellent documentation that is tough. Fortunately, that’s what technical writers are good at. Having a developer liaison for the docs team can free writers from having to think about the limitations of the technology they’re using so they can focus on writing the docs.