The formula to creating awesome docs
summary
Promises a concrete checklist and delivers a runnable toolkit: a live site phppackagechecklist.com and repeatable steps for naming, composer/Packagist publishing, PSR‑4 autoloading, PHPUnit tests and aiming for ~90% coverage, PSR‑2 formatting, Travis CI and Scrutinizer for CI, git tags + semantic versioning and a keep a CHANGELOG workflow, GitHub Pages/Jekyll for docs and an MIT license. Calls out big numbers—about 140,000 packages and 285 million installs a month—so this is practical packaging and doc ops, not high-level theory.
AI-written summary · about
chapters (13)
- 0:00Introduction
- 0:50About Jonathan
- 7:20Picking a name
- 10:35Open source
- 12:02Autoload
- 12:40Composer
- 15:02Framework agnostic
- 17:10Coding
- 19:57Docs
- 23:13Change logs
- 24:32Continuous integration
- 26:19Licenses
- 27:25Welcome Contributions
related talks
50mTools of the Trade
51mWriting the Darn Docs
35mBuilding Docs like Code: Continuous Integration for Documentation
36mBuilding Docs like Code: Continuous Integration for Documentation
47mThe Art of Documentation and Readme.md
39mDevelopers Documentation: your hidden strength
44mUseful and Beautiful Developer Docs and How to Create Them
40mFrom resistance to adoption: navigating the challenges of docs-like-code