loading words...

Mar 29, 2019 22:55:47

App and Frameworks on Documentation

by @valentino | 232 words | 60🔥 | 358💌

Valentino Urbano

Current day streak: 60🔥
Total posts: 358💌
Total words: 170604 (682 pages 📄)

Making an app and a framework are 2 very different things. Making an app you can be super specific in your coffee about what you need. Making a framework you need to be flexible cause it's certain that people will use it in ways that you didn't predict.

You can also avoid documenting your app's code as much since technically you are (likely) going to be the only person working on it. That might bite you later though. If you are working on a framework used by other people you don't have that luxury. Your documentation should be top notch, so many frameworks have terrible documentation and a lot of people (myself first) are taken aback just because of it.


A good example

- SwiftyJSON

Clear instruction on how to install it, clear examples that cover most (even advanced) use cases, and even examples on how to use it alongside other popular packages on the platform.


A bad example

- jstree

Just says obvious points that are in the name of the function and doesn't specify anything about the return value or argument to pass into the functions apart from the name and the type. You can get the exact same information by looking at the source code. What is the point of the documentation if you get nothing from it at all apart from what you would get by looking at the code itself?

Originally published at www.valentinourbano.com

contact: email - twitter / Terms / Privacy