Communities

Writing
Writing
Codidact Meta
Codidact Meta
The Great Outdoors
The Great Outdoors
Photography & Video
Photography & Video
Scientific Speculation
Scientific Speculation
Cooking
Cooking
Electrical Engineering
Electrical Engineering
Judaism
Judaism
Languages & Linguistics
Languages & Linguistics
Software Development
Software Development
Mathematics
Mathematics
Christianity
Christianity
Code Golf
Code Golf
Music
Music
Physics
Physics
Linux Systems
Linux Systems
Power Users
Power Users
Tabletop RPGs
Tabletop RPGs
tag:snake search within a tag
answers:0 unanswered questions
user:xxxx search by author id
score:0.5 posts with 0.5+ score
"snake oil" exact phrase
votes:4 posts with 4+ votes
created:<1w created < 1 week ago
post_type:xxxx type of post
Search help
Notifications
Mark all as read
Q&A

Posts tagged api-documentation

Subtag of technical-writing

This tag doesn't have any usage information yet.

This tag doesn't have a detailed wiki yet.

80%
+6 −0
Q&A HTML tags versus CSS classes: is one preferred over the other for the same styling?

We publish documentation online using HTML. For things like fixed parameter names and other code literals, we use &lt;code&gt; tags. My question is about styling these in tables. On our referenc...

2 answers  ·  posted 1y ago by Monica Cellio‭  ·  last activity 7mo ago by Canina‭

71%
+3 −0
Q&A 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 etc, I like to document each bit in detail and also include, regardless of the coding l...

4 answers  ·  posted 5y ago by Lefty G Balogh‭  ·  last activity 1y ago by Monica Cellio‭

75%
+4 −0
Q&A 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 is to imbibe good examples. Can you recommend any exam...

1 answer  ·  posted 8y ago by Stefan Piskorski‭  ·  edited 2y ago by Monica Cellio‭

66%
+2 −0
Q&A 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 examples of these manipulations, I have written a short sente...

4 answers  ·  posted 7y ago by Dave Jones‭  ·  edited 2y ago by Monica Cellio‭

60%
+1 −0
Q&A 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 writing? What aspects should I take care of?

3 answers  ·  posted 3y ago by Gergely‭  ·  last activity 3y ago by System‭

50%
+0 −0
Q&A 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 large C++ API. The usual tool of choice for Java APIs is Javadoc, but doxygen can do both and...

1 answer  ·  posted 6y ago by Monica Cellio‭  ·  last activity 3y ago by System‭

60%
+1 −0
Q&A 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). All I have to do is add some comments explaining what a class or method does and what...

4 answers  ·  posted 8y ago by Monica Cellio‭  ·  last activity 3y ago by System‭

60%
+1 −0
Q&A 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) for a computer application. What I have seen in usage wa...

2 answers  ·  posted 8y ago by Thomas E.‭  ·  last activity 3y ago by System‭

50%
+0 −0
Q&A 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 itself automatically. For example, for Java interfaces a typical t...

2 answers  ·  posted 9y ago by Monica Cellio‭  ·  last activity 3y ago by System‭

50%
+0 −0
Q&A 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 documentation automatically. What ar...

2 answers  ·  posted 5y ago by Timtech‭  ·  last activity 3y ago by System‭

60%
+1 −0
Q&A 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 methods. This includes, for example, Java Annotation and Microsoft's XML Documentation for .NET La...

0 answers  ·  posted 5y ago by EJoshuaS - Reinstate Monica‭  ·  last activity 3y ago by System‭

60%
+1 −0
Q&A 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 spending a bit of time on this I arrived ...

0 answers  ·  posted 7y ago by Shanimal‭  ·  last activity 3y ago by System‭

This community is part of the Codidact network. We have other communities too — take a look!

You can also join us in chat!

Want to advertise this community? Use our templates!

Like what we're doing? Support us! Donate