Beyond the README: Creating Effective Documentation for Your Project by Rand McKinney, IBM
Beyond the README: Creating Effective Documentation for Your Project by Rand McKinney, IBM
Beyond the README: Creating Effective Documentation for Your Project - Rand McKinney, IBM/StrongLoop
Documentation is a weak point for many Node projects. Many developers don’t like writing documentation, and often add it only as an afterthought, or after complaints. But particularly for complex modules or multi-module frameworks, good documentation is essential. For very simple modules, a basic README is often sufficient. But more complex modules or multi-module frameworks need more, and thi