"Too often, API documentation writing is introduced as a series of rules or gut feeling about what seems obvious. Beginning writing, that’s a good approach. They’re easily understood and conform to. They’re rarely wrong. They’re far from complete, however.API documentation writing is an art, not a science. As the artist, your influence is no less important than anyone else’s. But you’ll need to understand more in order to take the writing to a new level. You’ll need to know theory, the hows and whys, and to think like a programmer. The theory here is not only to connect with clients but also to present information in the most efficient way possible. It’s the last points that learning API documentation writing does not do well.The following is a talk through. I talk about an element in conversational detail. I aim to discuss the important points, why an approach may be inappropriate, what the goals should be, and how to fix it. Along the way, I may make blunt statements. I do that for effect. By exposing the reason for the critique, we can get an understanding of the solution. We’ll look at this from the writer’s perspective."robertdelwood.medium.com/impro#TechnicalWriting #APIDocumentation #SoftwareDocumentation #SoftwareDevelopment #Programming #APIs #TechnicalCommunication

you are viewing a single comment's thread
view the rest of the comments
[–] [S] 1 point 8 months ago

"[W]riters have a say in the design of the calls. We aren’t passive participants. Instead, we have the right, if not the obligation, to get involved with design. This also touches on why writers need to know some programming. We are the objectivity developers sometimes miss. Too often, it’s an unchallenged assumption that the in-house developers, just because they are developers, are always thinking about the clients or have the client’s best interest in mind. That’s not always the case. Writers can help here. In this instance, if something too difficult to explain, it’s not the explanation at fault, it’s the parameters. They need to be reconsidered, literally at the source."

  • source