Forum Discussion

Gaurav1's avatar
Occasional Visitor
6 years ago

Need for Technical Writer in API Documentation

I'm a technical writer, and recently I started learning about documenting APIs. After learning APIs for about 4-5 months, yesterday I got to know that programmers can automatically generate API Documentation by simply inserting a few lines of Swagger code (this includes, swagger .dll, nswag/swashbuckle) in their APIs. Moreover they can add descriptions/comments in their API.

Therefore, I want to know what is the need (scope of work) of a Technical Writer in API Documentation? Are they needed just to edit the descriptions written by programmers? Moreover, the programmers in my company feel that as the API they are developing is for internal use only, they are not very much concerned about the description/grammar.

Please help me in clearing my confusion.
No RepliesBe the first to reply