Making world-class docs takes effort
Author: Brad Frost
Making world-class docs takes effort
Metadata
- Author: Brad Frost
- Full Title: Making world-class docs takes effort
- Category: #type/articles
- URL: https://bradfrost.com/blog/link/making-world-class-docs-takes-effort/?utm_source=feedburner&utm_medium=feed&utm_campaign=Feed%3A+brad-frosts-blog+%28Brad+Frost+Web%29
Highlights
- Your docs belong in the code repository It needs to be next to the code so that authors and contributors can update/read the docs while working on the code or docs. Providing it in a separate repository or otherwise separated will undoubtedly lead to discrepancies sooner or later. Similar to how all wikis are always wrong. Your docs is not extracted from code Admit it. If you browse around you will realize that the best documented projects you find never provide that docs generated directly from code. Suc
Making world-class docs takes effort
Metadata
- Author: Brad Frost
- Full Title: Making world-class docs takes effort
- Category: #type/articles
- URL: https://bradfrost.com/blog/link/making-world-class-docs-takes-effort/?utm_source=feedburner&utm_medium=feed&utm_campaign=Feed%3A+brad-frosts-blog+%28Brad+Frost+Web%29
Highlights
- Your docs belong in the code repository It needs to be next to the code so that authors and contributors can update/read the docs while working on the code or docs. Providing it in a separate repository or otherwise separated will undoubtedly lead to discrepancies sooner or later. Similar to how all wikis are always wrong. Your docs is not extracted from code Admit it. If you browse around you will realize that the best documented projects you find never provide that docs generated directly from code. Suc