API documentation

Total: 10 results found.
Technical Documentation
(Services)
Good documentation is written for the user. Because it focuses on the knowledge and tasks of the user. That’s why we do not immediately start writing. First we analyze the users of your product: What are their skills? How do they work? This way, we can create documentation that is user-friendly  ...

read more...

Developer Documentation: The Necessary Evil?
(Knowledge Base)
Anna M. is a software engineer. She has just started working for a company that develops custom add-ons for an out-of-the-box financial software solution. For developing the add-ons, Anna is supposed to use the API of the software. Little does Anna know about the API's structure, its interfaces, and its functionality.  ...

read more...

API documentation – What software engineers can teach us
(Knowledge Base)
A guest article by Stephanie Steinhardt When asking software engineers about API documentation, you soon find out that there are two groups. The first group is convinced that good code does not require any explanation. Members of the second group frequently read documentation and even enjoy writing it. You also find  ...

read more...

Documentation for Software Engineers
(Knowledge Base)
Writing technical documentation for software engineers is more than authoring code comments. In order to use an application programming interface (API) or existing source code effectively, software engineers require different types of information. For this reason, technical writers who author API documentation need to  ...

read more...

tekom impressions part 2: API documentation and the VUKA world
(Blog)
Daniela Herbold and Ulrike Parson write about better API documentation and solutions for innovative human resources management.
Search
  • linkedin
  • xing