What, Why, How

I’m thinking the #WordPress Codex and Theme Review guidelines would benefit from a “what, why, how” approach to documentation:

  • What: describes the function or requirement
  • Why: why is it this way? Best practice, performance, security concerns?
  • How: a simple and clear code example of how to use or implement what is being discussed

Published by

Kirk Wight

I am a Code Wrangler at Automattic, helping make WordPress.com the best it can be. Pender Island, British Columbia, Canada is where I call home. Lover, not a fighter.

Leave a Reply

Fill in your details below or click an icon to log in:

Gravatar
WordPress.com Logo

You are commenting using your WordPress.com account. ( Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. ( Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. ( Log Out /  Change )

Cancel

Connecting to %s