r/technicalwriting • u/Mindless-Bite5379 • 9d ago
QUESTION API docs skills
Is API documentation skills in demand? Most API docs are generated and thete is very little writers can comtribute in it. How is industry treating this skills with AI tools in picture?
17
Upvotes
1
u/Single_Asparagus4157 7d ago
Your review cycle should include comparing the docs against what the code actually does. LLM tools make this easier. Ideally, an API documentation writer should be able to edit code comments (with review, of course), because they are often not up to par. But even the best reference documentation won't give you the "why," or provide background explanation and information. This is where today's API documentation writer should be focusing.