Tag: ApiDocumentation
Sorted by: Newest Newest Active Popular Oldest
: Recommendations for Better Documentation Tools My project at work has crept outside of the scope of our current tools (JSDocs). One of our APIs is in JavaScript, but we've also recently made
0 Reactions React
: What to do when API objects and UI names are different? This question is in reference to API documentation. Say the name of an object is "Action" in the backend, but "Step" in the UI. We
0 Reactions React
: What is special in API documentation compared to general technical writing? The title says it all: what is special in Application Programming Interface documentation compared to general technical
0 Reactions React
: What is the status of Sandcastle and are there alternatives? Wikipedia currently lists the Development Status of the Sandcastle documentation generation software as "Stalled," citing the lack of
0 Reactions React
: Are there valid reasons to write Java Annotation (or .NET XML Documentation) for private methods? At this point, many languages have some "standard" format for writing documentation for individual
0 Reactions React
: What are the benefits of including complete working code samples in documentation When documenting software API so others know how to access the various methods, what data structures are used
0 Reactions React
: When documenting Python, when should I use docstrings and when should I use comments? Python programming language provides two mechanisms for documenting a function, a module or a class: Comments
0 Reactions React
: Limitations of automatic documentation As technology advances and workflows are streamlined, some have turned to automated tools such as Doxygen, Sphinx, Swagger, etc. in order to generate technical
0 Reactions React
: How to avoid stacking headings in documentation, theses etc I very often come into situations where I either stack headings, i.e. I have headings with no content, or where I write some content
0 Reactions React
: How can I publish package overviews (Java) or namespace overviews (C++) using Doxygen? We use doxygen to generate API (reference) documentation for our code. We have a small Java API and a
0 Reactions React
: Documenting a Mongo Collection Field While writing some documentation I stumbled upon the need to describe the location of a field in a Mongo Collection on one of our corporate servers. After
0 Reactions React
: How do I start to document an API that uses C#? I have no experience writing API documentation, but a need has arisen for it at my company. However, the only guides I can find for API Documentation
0 Reactions React
: How to structure a sentence containing long code examples? In the context of a technical manual, I need to write instructions guiding users through several standard manipulations. When providing
0 Reactions React
: Difference b/w Abstract and Introduction writing for a research paper I was slightly confused with differentiating Abstract and Introduction writing for a research paper. What is the difference
0 Reactions React
: Tools for multiple creators/writers documentation without clouds In many companies I've seen it that more than 1 person are writing at the same documentation (be it user manual or technical documentation)
0 Reactions React
: Good Examples of and Practices in Code Documentation I noted in this question: What is the best way to learn technical writing? ...that a rated method to learn how to write technical documents
0 Reactions React
: How can I write better code-based reference documentation for programming interfaces? Programmers can write comments in code that can be automatically turned into API documentation (like Javadoc).
0 Reactions React
: API reference doc: best practices for describing opaque parameters? The reference documentation for an application programming interface (API) is, in modern systems, usually generated from the code
0 Reactions React
: Mashery vs. Apigee I was wondering if anyone could lend some advice as to the pros and cons between using Mashery versus Apigee for documenting an API? I have do some evaluating and have about
0 Reactions React
Next Page
Feed
Terms of Use Powered by ePowerPress Stock Market News!
© selfpublishingguru.com2024 All Rights reserved.