3 ms·
> I absolutely despise writing documentation You really should learn that skill because it's very important in most software companies, and mandatory for some
by JTyQZSnP3cQGa8B 4y ago
> I absolutely despise writing documentation
You really should learn that skill because it's very important in most software companies, and mandatory for some fields like the healthcare industry. It is, like unit-tests or code coverage, a skill that makes a difference between a developer and a senior developer.
Also my pain point is when documentation is not written when it's so easy to use nowadays with files in a docs/ directory, wikis, or comments like Doxygen. We don't need more tools, we need discipline. I'm still trying to understand what your service could bring me, and why I would pay for this.
Last but not least, in the comparison page (https://documentationlab.com/blog/best-software-documentation-tools-of-2023 https://documentationlab.com/blog/best-software-documentatio...), you describe Read the docs as a tool when it's only a web site to store user-generated content (from Sphinx or any other tool). That's why it's more confusing.
- doclab 4y agoI do write documentation, but what often happens in companies is that you are forced to use Confluence or other such software since the documentation has to be available and editable for all kinds of users in your company. Technical or non-technical. This makes it a hassle for developers to use these tools when they really would like your example of docs directory. What I'm trying to do is to have the same advantages as tool like confluence but make it as developer friendly as possible. With my tool, you can actually just write the docs into the docs directory if you want and then sync them with our cli tool so you can also edit and view them with your browser from anywhere. When a company needs such tool, they also usually have a problem that the documentation is not up-to-date; my git integration is made to address that. I think if you don't have these kinds of needs or problems I'm describing. You are able to write your docs to the doc folder and don't value the git integration or AI assistant, this probably ain't the tool for you. I completely understand why it sounds useless to you, but from working in the from software industry for a decade I believe there are enough companies with these kinds of problems I'm addressing. Also thank you for feedback. Based on the comments I'm getting it seems like my web page isn't communicating the advantages of my tool well enough and I'll definitely need to fix that in the upcoming weeks.