Core Docs: Sentencing WordPress to 11-years-to-life
1 like5,175 views
The document discusses plans to improve WordPress documentation by focusing on four main areas: 1) a developer hub with code reference and standards documentation, 2) handbooks for plugins and themes, 3) a support hub for getting started guides and knowledge base, and 4) dismantling the outdated Codex in favor of inline documentation. It also outlines ideas for enhancing documentation such as examples voting, explanations, and adopting JavaScript commenting standards. The overall goal is to reduce scope, refine content, and separate developer and user-focused documentation.
Core Docs: Sentencing WordPress to 11-years-to-life
- 1. CORE DOCS: SENTENCING WORDPRESS TO 11-YEARS-TO-LIFE
- 2. WHAT IS CORE DOCUMENTATION? • The Codex • Inline docs/commenting • The code itself • Docs as “developer experience”
- 4. CINCINNATI MEETUP • Survey analysis • Brainstorming • Roadmap
- 5. CODEX SURVEY • Incomplete, outdated, wrong • Tutorials and examples • StackExchange/StackOverflow
- 8. ROADMAP http://make.wordpress.org/docs/2013/06/19/docs-sprint-results-and-roadmap/
- 9. ROADMAP • Constrain the scope of docs to the core project • Reduce and refine • Separate developer from user documentation
- 10. 1. DEVELOPER HUB
- 11. 1. DEVELOPER HUB • Code Reference • Standards/Parser • Hook Docs • Code Reference Theme
- 12. CODE REFERENCE
- 13. EXAMPLE EXAMPLE
- 14. + 2. HANDBOOKS
- 15. 2. HANDBOOKS • Plugin, theme developers • Polyglots, users, etc. • Rewrite, focus the content • Reorganize
- 17. 3. SUPPORT HUB
- 18. 3. SUPPORT HUB • Getting Started, task-based guides • Knowledge base • Identifying cross-over content
- 19. 4. DISMANTLING THE CODEX
- 20. 4. DISMANTLING THE CODEX • Migrate remaining content to inline docs and explanations • Massive 301 redirect
- 21. WHAT’S NEXT
- 22. SHINY THINGS • Examples voting • Explanations • Hook aliases • Documenting default arguments
- 23. SHINY IDEAS • Adopt the JSDoc3 standard • Parsed JavaScript docs • Extended references • and …
- 25. Drew Jaynes | @DrewAPicture Slides: http://drewf.us/wcnyc