Docs

Migrating from Markdown to structured authoring

I’m a huge fan of Markdown. It’s great for wikis and writing content for static sites (most of the content on this site is written using it).

Creating documentation in XML

If your documentation has reached the limits of what’s possible in Markdown, and you’d prefer not to fall back to HTML, it’s time to consider authoring in XML.

Creating documentation in an agile environment

Google for images of agility, and you’ll get dog trials. So let’s go with that analogy.

Getting started with REST APIs

REST (representational state transfer) APIs (application programming interfaces) have been around since the turn of the century, when they were defined by Dr.

Revisitng DocBook

The Darwin Information Typing Architecture (DITA) and DocBook are two XML-based authoring frameworks.

Using LanguageTool to improve your writing

As I’ve previously remarked, I missed two things on switching from print journalism to technical writing.

Creating a writing style guide

When I switched from journalism to technical writing, the two things I missed the most were style guides and editors.

Creating API docs for assembly language projects

This week, I’m releasing what I hope will be the penultimate beta of SE Basic IV (an open source classic BASIC interpreter).