Right?īut without documenting what you’ve done and why you’ve done it: You want your code to be best in class, easy to read, easy to use, and you want great things to happen as a result of it.
“ If it isn’t documented, it doesn’t exist” – Sitepoint, A Guide to Writing Your First Software DocumentationĪs a developer, your main aim is to write the best code you possibly can. “ Documentation in software engineering is the umbrella term that encompasses all written documents and materials dealing with a software product’s development and use” – Prototype.io, Software Documentation Types and Best PracticesĪll pieces of software should have some form of documentation that explains, in detail, what the product is, how it works, and why it works that way.
As you can see, Slack explains everything about its API in excruciating detail.
0 kommentar(er)
