InchJS: How to get people excited about inline docs
summary
A command-line tool that scores and grades individual functions and parameters and a complementary CI service that posts a CI badge in README are built and running; scoring uses simple rules (longer functions, many params, exported APIs) to compute a priority and a 0–100 score bucketed into A/B/C grades, shows per-object suggestions and a grade distribution, and the public service reaches over 2,100 READMEs so the approach clearly drives visibility and adoption.
AI-written summary · about
chapters (8)
- 0:00Introduction
- 3:08What are inline docs
- 5:51Why do I care
- 7:38Tools
- 9:23Design Process
- 16:10Demo
- 19:29Badges
- 24:20Things I learned
related talks
35mMetric driven documentation
47mThe Art of Documentation and Readme.md
23mMaster JIRA APIs: Essential Documentation Tips
36mEnforcing coding standards in a JS library
58mImproving Quality of JavaScript Code
49mExplain Yourself! Documentation for Better Code
01h 01mUseful Tools and Utils for JS Development
20mSEO for Developers