DEV Community

Discussion on: What makes maintaining documentation difficult?

Collapse
 
cjbrooks12 profile image
Casey Brooks

Personally, I find myself more in the latter group, but wanting to get into the former. Given that I do not write much documentation:

1) It's hard to justify taking the time to write documentation when I could be fixing bugs or creating new features.
2) I depend almost exclusively on official documentation (as opposed to other resources like Stack Overflow), and I recognize the impact that good documentation has on the community.
3) Most projects would benefit from managing documentation in multiple ways (code API docs, wiki, changelogs, etc.), and I want to manage all these in one place rather than having to use multiple tools for all these. Full disclosure, this answer is loaded as I am developing Orchid for exactly this purpose. Nevertheless, I started creating Orchid precisely because the market for documentation tools are all so isolated and hard to manage.