Push your doco to the next level

Creating Manuals Using RST and Sphinx: Child Documents

Child documents, or sub-documents, make up the bulk of a project. Think of them as Lego blocks – pieces of various sizes that can be put together to make all sorts of end documents. Each child document answers a single question, or addresses a single topic.

How to Develop Agile Documentation

Traditional software documents are created from the top down. Figure out who will be doing what with the software, then write documents aimed at each category of users, explaining how to use every bit of functionality they should (theoretically) need to use. This method really doesn’t fit in well with modern software design. So how can we use basic concepts from Agile methodology to develop Agile documentation?

How to Create a Documentation Strategy

Your documentation is one of the first things people look at when they’re having trouble using your product – or thinking of using your product. As such, it’s a powerful ambassador for your company.

So let’s look at some of the aspects of documentation strategy that you need to consider.