How do I read API documentation? [closed]
Closed 8 years ago.
What kinds of visual content, tables or diagrams might I want to include in my Project Architecture Document?
Besides logical and physical architecture diagrams, comps / mockups and tables for expected network load between components and various data schemas, what kinds of visual content, tables or diagrams might I want to include in my Project Architecture Document?
How to visually document interactive user interfaces for fast consumption
I’m writing documentation for some interactive Ajax user interface but instead of writing everything in words I would rather provide diagrams that are faster consumed than whole paragraphs of text. I did provide page navigation flow diagram but that’s very high level before you drill down to individual pages and their inner workings.
Design documents as part of Agile
At my workplace, we face a challenge in that “agile” too often has meant “vague requirements, bad acceptance criteria, good luck!” We’re trying to address that, as a general improvement effort.
What level of detail to use in an interface members descriptions?
I am extracting interfaces from some classes in .NET, and I am not completely sure about what level of detail of description to use for some of the interface members (properties, methods).
Specifying Author in Source Code in a Commercial Product
Usually there is an @author tag in API documentation (JavaDoc, PHPDoc etc). Is it acceptable to use this tag on every function you make in a commercial product?
How to document requirements for an API systematically?
I am currently working on a project, where I have to analyze the requirements of two given IT systems, that use cloud computing, for a Cloud API. In other words, I have to analyze what requirements these systems have for a Cloud API, such that they would be able to switch it, while being able to accomplish their current goals.
What to put in a Stored Procedure documentation?
I was tasked to document our stored procedures.
What Does It Usually Mean for a Feature to be “Supported”?
I’m currently working some testing for a particular area of an application. I had to write some automated tests for a particular feature but due to the circumstances, this was not easy to do. When I asked one of the other testers about it, he mentioned that the same features exist in a sister application our company produces but isn’t documented anywhere (end-user documentation or otherwise). He also said that the feature doesn’t typically get tested at all in the sister application and isn’t usually tested in the application I work on. Apparently this feature isn’t heavily used but removing it would require a fair bit of work so the benefit-cost ratio doesn’t work out.
What Does It Usually Mean for a Feature to be “Supported”?
I’m currently working some testing for a particular area of an application. I had to write some automated tests for a particular feature but due to the circumstances, this was not easy to do. When I asked one of the other testers about it, he mentioned that the same features exist in a sister application our company produces but isn’t documented anywhere (end-user documentation or otherwise). He also said that the feature doesn’t typically get tested at all in the sister application and isn’t usually tested in the application I work on. Apparently this feature isn’t heavily used but removing it would require a fair bit of work so the benefit-cost ratio doesn’t work out.