Tag: documentation
-
Sep 30, 2017
Building an interlinked Github wiki from markdown topics
I use markdown wherever possible since it is a very simple and clean syntax to work with and is easy to read as-is. One of the areas that I’ve wanted to adopt markdown for a while is for documentation but somehow without compromising on the high quality linking that I have between topics.
-
Feb 2, 2013
Syntax highlighting with DITA
Syntax highlighting is something that I like in user documentation because I feel that it helps make source listings easier for people to understand.
-
Aug 3, 2012
Working with DITA topic identifiers
When writing my new user documentation using DITA I have found myself attempting to maintain a consistent naming convention for my unique topic IDs. The problem with this approach (to me at least) is that it would be fairly easy to inadvertently reuse the same “unique” identifier for two separate topics.
-
Jul 29, 2012
Choosing a documentation solution
For a while I have been using Microsoft Word to author user guides and to be fair this has been a good solution up until now. Since beginning work on Rotorz Tile System there have been a number of product updates which have required multiple updates of the user documentation. Despite using style presets the process of maintaining consistent formatting and updating illustrations is extremely time consuming. I also feel that there is a need for a web based version of the documentation to make it easier for people to find their way around.