Writing - Posts tagged api-documentation

66%

+2 −0

How to structure a sentence containing long code examples?

5 answers · last activity 3 months ago by ‭Monica Cellio‭

style technical-writing examples api-documentation

60%

+1 −0

What are the benefits of including complete working code samples in documentation

5 answers · last activity 3 months ago by ‭Monica Cellio‭

software-documentation examples api-documentation

50%

+0 −0

Good Examples of and Practices in Code Documentation

2 answers · last activity 3 months ago by ‭Monica Cellio‭

technical-writing software-documentation examples api-documentation

50%

+0 −0

What is special in API documentation compared to general technical writing?

4 answers · last activity 11 months ago by ‭System‭

technical-writing api-documentation documentation

50%

+0 −0

How can I publish package overviews (Java) or namespace overviews (C++) using Doxygen?

1 answer · last activity 11 months ago by ‭System‭

software tools technical-writing api-documentation documentation

60%

+1 −0

How can I write better code-based reference documentation for programming interfaces?

5 answers · last activity 11 months ago by ‭System‭

software technical-writing software-documentation api-documentation documentation

60%

+1 −0

Tools for multiple creators/writers documentation without clouds

2 answers · last activity 11 months ago by ‭System‭

tools api-documentation documentation

50%

+0 −0

API reference doc: best practices for describing opaque parameters?

2 answers · last activity 11 months ago by ‭System‭

technical-writing api-documentation documentation

50%

+0 −0

Limitations of automatic documentation

2 answers · last activity 11 months ago by ‭System‭

software tools api-documentation documentation

50%

+0 −0

What is the status of Sandcastle and are there alternatives?

2 answers · last activity 11 months ago by ‭System‭

software tools software-documentation api-documentation documentation

60%

+1 −0

Are there valid reasons to write Java Annotation (or .NET XML Documentation) for private methods?

1 answer · last activity 11 months ago by ‭System‭

software software-documentation api-documentation documentation

60%

+1 −0

When documenting Python, when should I use docstrings and when should I use comments?

2 answers · last activity 11 months ago by ‭System‭

technical-writing api-documentation documentation

50%

+0 −0

How to avoid stacking headings in documentation, theses etc [closed]

0 answers · last activity 11 months ago by ‭System‭

api-documentation headlines documentation

60%

+1 −0

Documenting a Mongo Collection Field

1 answer · last activity 11 months ago by ‭System‭

api-documentation documentation

60%

+1 −0

How do I start to document an API that uses C#?

2 answers · last activity 11 months ago by ‭System‭

resources api-documentation documentation

60%

+1 −0

Difference b/w Abstract and Introduction writing for a research paper

3 answers · last activity 11 months ago by ‭System‭

research academic-writing api-documentation documentation

50%

+0 −0

Mashery vs. Apigee

1 answer · last activity 11 months ago by ‭System‭

tools technical-writing api-documentation documentation