Your SlideShare is downloading. ×
0
Core Docs: Sentencing WordPress to 11-years-to-life
Core Docs: Sentencing WordPress to 11-years-to-life
Core Docs: Sentencing WordPress to 11-years-to-life
Core Docs: Sentencing WordPress to 11-years-to-life
Core Docs: Sentencing WordPress to 11-years-to-life
Core Docs: Sentencing WordPress to 11-years-to-life
Core Docs: Sentencing WordPress to 11-years-to-life
Core Docs: Sentencing WordPress to 11-years-to-life
Core Docs: Sentencing WordPress to 11-years-to-life
Core Docs: Sentencing WordPress to 11-years-to-life
Core Docs: Sentencing WordPress to 11-years-to-life
Core Docs: Sentencing WordPress to 11-years-to-life
Core Docs: Sentencing WordPress to 11-years-to-life
Core Docs: Sentencing WordPress to 11-years-to-life
Core Docs: Sentencing WordPress to 11-years-to-life
Core Docs: Sentencing WordPress to 11-years-to-life
Core Docs: Sentencing WordPress to 11-years-to-life
Core Docs: Sentencing WordPress to 11-years-to-life
Core Docs: Sentencing WordPress to 11-years-to-life
Core Docs: Sentencing WordPress to 11-years-to-life
Core Docs: Sentencing WordPress to 11-years-to-life
Core Docs: Sentencing WordPress to 11-years-to-life
Core Docs: Sentencing WordPress to 11-years-to-life
Core Docs: Sentencing WordPress to 11-years-to-life
Core Docs: Sentencing WordPress to 11-years-to-life
Upcoming SlideShare
Loading in...5
×

Thanks for flagging this SlideShare!

Oops! An error has occurred.

×
Saving this for later? Get the SlideShare app to save on your phone or tablet. Read anywhere, anytime – even offline.
Text the download link to your phone
Standard text messaging rates apply

Core Docs: Sentencing WordPress to 11-years-to-life

3,829

Published on

Core docs extend far beyond maintaining dated Codex pages and writing inline comments. In fact, even the way core code is written is a contributor to core documentation. And in all the ways we …

Core docs extend far beyond maintaining dated Codex pages and writing inline comments. In fact, even the way core code is written is a contributor to core documentation. And in all the ways we contribute docs, we need to ensure they stand the test of time.

This talk takes a stroll through the docs roadmap devised Summer 2013 and how that’s progressing. We’ll examine the diminished role the Codex will take going forward, as well as highlight some exciting initiatives coming into the fold — including the handbooks, code reference, and more.

Published in: Education
0 Comments
1 Like
Statistics
Notes
  • Be the first to comment

No Downloads
Views
Total Views
3,829
On Slideshare
0
From Embeds
0
Number of Embeds
6
Actions
Shares
0
Downloads
1
Comments
0
Likes
1
Embeds 0
No embeds

Report content
Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
No notes for slide

Transcript

  • 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”
  • 3. CINCINNATI 2013
  • 4. CINCINNATI MEETUP • Survey analysis • Brainstorming • Roadmap
  • 5. CODEX SURVEY • Incomplete, outdated, wrong • Tutorials and examples • StackExchange/StackOverflow
  • 6. LIKE DON’T LIKE
  • 7. CODEX != SUSTAINABLE
  • 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
  • 16. 3. SUPPORT HUB
  • 17. 3. SUPPORT HUB • Getting Started, task-based guides • Knowledge base • Identifying cross-over content
  • 18. 4. DISMANTLING THE CODEX
  • 19. 4. DISMANTLING THE CODEX • Migrate remaining content to inline docs and explanations • Massive 301 redirect
  • 20. WHAT’S NEXT
  • 21. SHINY THINGS • Examples voting • Explanations • Hook aliases • Documenting default arguments
  • 22. SHINY IDEAS • Adopt the JSDoc3 standard • Parsed JavaScript docs • Extended references • and …
  • 23. Drew Jaynes | @DrewAPicture Slides: http://drewf.us/wcnyc

×