To write good class- and method- level documentation for a public API , keep the following in mind: Good documentation writers are cross-functional: good engineers, but also good communicators, like writers and UX designers, who know how to structure and present information in a way that gets the message across. They can see it from the other side of the table.
How To Write Good API Documentation
How To Write Good API Documentation
How To Write Good API Documentation
To write good class- and method- level documentation for a public API , keep the following in mind: Good documentation writers are cross-functional: good engineers, but also good communicators, like writers and UX designers, who know how to structure and present information in a way that gets the message across. They can see it from the other side of the table.