Writing Technical Documents with Org Mode

alpha2phi has a nice post on writing documentation with Emacs and Org-mode. The post is reminiscent of Mike Hamrick’s video on keeping technical documents consistent and uses some of the same techniques.

Alpha2phi starts with importing Fabrice Niessen’s excellent ReadTheOrg theme for exporting (to HTML) Org documents. Like Hamrick, he imports a separate file with useful utility functions, including an initialization function that is called from the document’s header.

Finally, he shows how you can call a function to interpolate a value or some text in the body of the document.

This post is a nice complement to Hamrick’s video. If you prefer to read the material rather than watch a video of it, take a look at this post. The material is very useful for anyone writing documentation.

This entry was posted in General and tagged , . Bookmark the permalink.