...
From Writing API Documentation -> Developing API Documentation
Make it easy to create by designers and developers
Make it easy to access and relevant to developers
Developer engagement
Make it easy to use: Sample Calls and Code are essential
Try It For Yourself (TIFY) Examples
Panes on page with prose, sample code, and navigation / search
Keep simple and easy to understand
Copy and paste friendly
Target languages (and code generation)
Team (please add your name below to sign up
...
)
- Andy Mayer (Modeling Subcommittee)
- Timo Perala (Documentation Project)
...