2. Disclaimer The views and statements contained herein are my own (Neil Mansilla) and do not express the views of Mashery, Inc. nor any of its employees, agents, customers, and associates. Also, I’m not a Power Point guru, nor am I Anthony Robbins.
13. What does bad documentation really say about your platform? Your company?
14. Bad docs say to your users,“I don’t care about you.” Do your docs elicit any of these responses? “Why are these docs so awful?” “Don’t they realize this looks like hell?” “How in the world am I supposed to understand how this thing works?” “Do they no longer support this platform?” “Dude, these guys are bozos.”
15. A Few Common Pitfalls That Make for Bad Docs http://www.atarimagazines.com/hi-res/v1n2/davidcrane.php
18. other content.Common types of documentation include user guides, white papers, on-line help, quick-reference guides. It is less common to see hard-copy (paper) documentation. Documentation is distributed via websites, software products, and other on-line applications. [edit] Principles for producing documentation The following is a list of guides dealing with each specific field and type: documentation in health care [5] thesis writing [6], [7], [8] Further information: Dissertation papers for academic journal publishing (i.e. Journal of Food Science [9] and Analytical Chemistry [10]) Producing documentation Technical writers and corporate communicators are professionals whose field and work is documentation. Ideally, technical writers have a background in both the subject matter and also in writing and managing content (information architecture). Technical writers more commonly collaborate with subject matter experts (SMEs), such as engineers, medical professionals, or other types of clients to define and then create content (documentation) that meets the user's needs. Corporate communications includes other types of written documentation that is required for most companies. [edit] Specializing documentation Marketing Communications (MarCom) MarCom writers endeavor to convey the company's value proposition through a variety of print, electronic, and social media. This area of corporate writing is often engaged in responding to proposals. Technical Communication (TechCom) Technical writers document a company's project or service. Technical publication include user guides, installation manuals, and troubleshooting/repair/replace
21. other content.Common types of documentation include user guides, white papers, on-line help, quick-reference guides. It is less common to see hard-copy (paper) documentation. Documentation is distributed via websites, software products, and other on-line applications. [edit] Principles for producing documentation The following is a list of guides dealing with each specific field and type: documentation in health care [5] thesis writing [6], [7], [8] Further information: Dissertation papers for academic journal publishing (i.e. Journal of Food Science [9] and Analytical Chemistry [10]) Producing documentation Technical writers and corporate communicators are professionals whose field and work is documentation. Ideally, technical writers have a background in both the subject matter and also in writing and managing content (information architecture). Technical writers more commonly collaborate with subject matter experts (SMEs), such as engineers, medical professionals, or other types of clients to define and then create content (documentation) that meets the user's needs. Corporate communications includes other types of written documentation that is required for most companies. [edit] Specializing documentation Marketing Communications (MarCom) MarCom writers endeavor to convey the company's value proposition through a variety of print, electronic, and social media. This area of corporate writing is often engaged in responding to proposals. Technical Communication (TechCom) Technical writers document a company's project or service. Technical publication include user guides, installation manuals, and troubleshooting/repair/replace
22. Too Little a/k/a “Just Enough to Tick You Off” Method: createSituation(s3, s4, s5) This method creates a situation and takes in three parameters. Method: selectUserByDate(date) This method selects a user by a date.
23. Too Little a/k/a “Just Enough to Tick You Off” Method: createSituation(s3, s4, s5) This method creates a situation and takes in three parameters. Method: selectUserByDate(date) This method selects a user by a date.
24.
25.
26. Bad Docs = Angry Developers http://www.flickr.com/photos/gcarvalho/142922427/
45. Google Discovery FormatJSON, RESTful APIs http://code.google.com/apis/discovery/v1/reference.html#resource_discovery URL Shortener API: https://www.googleapis.com/discovery/v1/apis/urlshortener/v1/rest New Web Service Definition Formats & Tools