Several times, I’ve mentioned that I’m a huge fan of markdown – I use it to write emails, I dig that that’s how GitHub handles README files, I use minor variations of it in my blogging, and I’ve got a favorite app for it.
Thanks to a heads up from one of my partners, I can now write documentation with markdown.
Here’s the thing: I’ve mentioned that I’m a huge advocate for code comments - I think it’s better to go a little overboard for the sake of clarity than not, especially in open source projects.
And sure, PHP DocBlocks and tools like PHPDocumentor make it relatively easy to generate documentation, but documentation like that is best suited for other developers. It’s not exactly end-user friendly, right?
In that case, you’re talking about writing a manual.