Home/ Questions/Q 213453
In Process

The Archive Base Latest Questions

Editorial Team
  • 0
Asked: 2026-05-11T18:16:47+00:00

As a developer I really don’t like writing documentation but when I have to

  • 0

As a developer I really don’t like writing documentation but when I have to I’d like to make the process as painless as possible.

The problem with Word is that it constantly gets in my way. I worry more about the layout than about the actual content … that’s why I’d like to get rid of Word.

Ideally I’d like to write my content and then ‘compile’ it into a document.

I’ve heard of LaTeX but I don’t have any experience with it whatsoever. Would this be the right technology for the job? What editor (Windows) should I use? Is it a good idea to start with LyX?

EDIT: I’m not asking about documenting code (I use Sandcastle for that).

Update 2014:

We have now switched to GFM (GitHub Flavored Markdown).

  • It’s really easy to work with.
  • Write code & documentation in the same IDE!
  • Everything can be versioned!
  • Get great output either as raw txt, html or pdf!
Share

Leave an answer

You must login to add an answer.

Need An Account,

1 Answer

  1. Editorial Team

    I’ve found that wikis can be good for this. Find a wiki you like that lets you do a bit of formatting, but nothing really heavy. Ideally it should let you format code easily too – to be honest, the markdown available on SO is probably a good start.

    That way:

    • You have change tracking built-in (assuming a decent wiki)
    • You can edit from anywhere
    • Everyone always sees the same documentation (instant distribution)
    • You can concentrate on content instead of formatting
    • 0