Are you writing or maintaining an api doc generator for a programming language?

Lots of docs are served straight out of git. Please on't generate commit noise on every generated page.

- Don't generate a version number or time/date onto every page, stick it into the main page at most.
- Alternatively, use a CSS :before or :after rule to generate such content onto every page. Thereby only the changed CSS shows up in the commit.

Thanks.

#typedoc #javadoc #pydoctor #apidoc #doxygen

Slash documentation time by 83%:

- Traditional API docs: 3 hours
- AI-driven with review: Just 35 minutes

Syncs seamlessly with your code. Let developers code, let AI handle docs. Erase documentation debt.

#Documentation #APIDoc #AIAutomation #DeveloperProductivity

初心者向けapiDoc入門：簡単なAPIドキュメントの作り方
https://qiita.com/satokenichi/items/b310d193e0d7c1c1d829?utm_campaign=popular_items&utm_medium=feed&utm_source=popular_items

#qiita #初心者向け #apiDoc #API開発 #ドキュメント生成

AsyncAPI: Any folks with experience documenting non-RESTful APIs and other async message protocols?

Any tips or advice?

I'm having way too much fun in Redocly's beta sandbox.

I've got a bit of experience with OpenAPI/Swagger/REST so I'm mostly worried about "false friend" equivalencies and gotchas.

I'm also excited about bringing some APIs out of the Stone Age of pages of PDF tables.

#apiDoc #apiDocumentation #redocly #technicalWriting #documentation #techWriterLife #asyncAPI

#Introduction

I'm Paul Goble in Nebraska & Colorado, USA.

#NotMe: Childrens author, Eurasian expert

Values: #LoveGod #LovePeople #truthmatters #CovidIsNotOver

Work: Technical writer #techcomm #scicomm #icpms #spectroscopy #uxdesign #apidoc #instrumentation

Interests: #physics #linguistics #risks #lighting #VisualArts  #nature #ChristianFiction #libraries #meteorology

Play: #violin #recorder

Orgs: #ieee-pcs #acm #sigdoc #stc

Pronouns: Talk to me, not about me.

Mastodon accounts:
@pgcommunication for visual and technical communication.
@pgcommunication for everything else.

Everyone is looking to me for API doc best practices and process. Validating, but also a little intimidating, like the teacher learning the content the night before to stay ahead of the API doc class while teaching seven other classes at the same time.

I'd appreciate y'all sharing any thoughts & references & resources, from theory to implementation.

#technicalWriting #techWriterLife #writeTheDocs #loneWriter #apiDoc #apiDocs #apiDocumentation

I'm Paul Goble in Nebraska & Colorado, USA. I care about you.

#NotMe: Childrens author, Eurasian expert

Values: #LoveGod #LovePeople #truthmatters #CovidIsNotOver

Work: Technical writer #techcomm #scicomm #icpms #spectroscopy #uxdesign #apidoc #instrumentation

Interests: #physics #linguistics #risks #lighting #VisualArts  #nature #ChristianFiction #libraries #meteorology Play #violin #recorder

Orgs: #ieee-pcs #acm #sigdoc #stc

Pronouns: Talk to me, not about me.

#introduction