Wpwatercooler - Weekly Wordpress

EP43 – WordPress Web Development Documentation – July 15 2013

Informações:

Sinopsis

Today's topic is about Documentation. Documentation for a website, plugin or theme is an important component of a project. It allows the uninitiated to work with your code on either the web side of things or adding to your existing code. Documentation enables your customers to understand how to use what you have built for them. Commenting your code isn't enough, not everyone reads and interprets PHP and Javascript so taking the extra effort to explain how to use what you built will save people time, frustration and racking up support tickets for you to deal with. On this weeks topic of WPwatercooler we will be discussing documentation of all aspects. How does the customer expect the documentation to be and how a web developer can save money in spending the extra time writing, updating and cultivating good documentation for their customers. Why are some companies so bad at providing documentation? If you’re a developer and you’ve spent many hours writing code working with or creating API’s, and you want to bri