This article is mainly aimed at open source projects, but could apply just as well to any team releasing a product — be that an API, some developer tools, some binaries (from a few libraries or a full platform) — or attempting to build an ecosystem around an app or service.
I read a nice article the other day that makes the argument that documentation is more important than ever if you have an open source project to promote. How else will developers get up to speed with your project and learn what they need about it, if you don’t document it well? The article lists out some of the types of documentation you need to provide, such as a readme, some reference documentation, guides and so on.
from DZone.com Feed https://ift.tt/2ND9CP0
No comments:
Post a Comment