@vrypan.eth

I wish projects used AI to build better documentation. Rn, 99.99% of the documentation out there is either: - written for script kiddies that just want to copy-paste code and hope it works. - (practically) internal technical documentation, written to be read as a reference for the people that are already deep in the project. - a mix of both, with 2 paragraphs explaining a complex technical concept as if readers have spent their life working on it, and a meaningless example in code that makes sense only if you use a very specific set of libraries, toolchain, and environment. Proper documentation used to be a difficult and boring process that required deep technical knowledge (and the devs that have this knowledge prefer to use it to write code, not documentation) and communication skills (and the people who know how to write comprehensive, easy to read documents often lack technical knowledge). It's easy to solve this now. A good technical writer can ask an AI to analyze the project code, and guide it to write good documentation. Sometimes, it's even better if the writer does not have expertise in the specific project, so they can understand what a newcomer needs.

3 replies

0 recast

17 reactions