Corrections · 2
Making documentation easy and funny v1
"I started a blog to improve my English. I appreciate your help to check my grammar"
I know, that sounds impossible but we must find ways to make our lives as easy as possible in this important topic. Being honest, documentation could be at least be more easy but if not funny not to much. It will would be funny when if you could generate documentation with a simple instruction. Documentation is the most boring activity a developer can do. Maybe because it can’t be compiled or executed (I have heard this before), the things that developers are familiar with. Additionally, users do not read documentation or manuals, so developers feel they are doing something no one will use.
In From my point of view there are two kinds of documentation:
1. Documenting what you learned
This must be the most important kind for a developer because it represents what the developer have has learned, the best practices, etc. Things that must be documented are to not to be forged (?). Especially because the developer hates to do repetitive tasks. This kind of documentation is generated by the developer to himself, so it must not be too boring.
2. Documenting what you do did
This kind of documentation makes reference to designs, decisions and reasons of why something was done made on that way. This documentation must be done while the product or system is being developed. Making the documentation after the software has been finished has does not make sense.
## Documenting what you have learned
I prefer to document knowledge instead of a specific functionality, It makes me understand a topic better a topic and to record important aspects I probably will would forget otherwise. Do not waste time writing documentation or a summary of a topic in a local file in on you computer. I prefer on line tools like wikis and blogs. You can access them and modify the information at any time from any place. Moreover, those notes can be useful for other developers like you, who can give you feed back feedback. Furthermore, these blogs and wikis improve your skills and CV. Imagine what an employer will think about a persons who has a blog with interesting topics and some followers. You demostrate skills and knowledge about something. Surely he will think you are a good candidate.
There are a lot of open source tools you can install or subscribe to like:
* [Ghost](https://ghost.org/)
* [Dropplets](http://dropplets.com/)
* [DokuWiki](https://www.dokuwiki.org/)
* [MediaWiki](http://www.mediawiki.org/)
These are some free online free platforms you can use:
* [Wordpress](http://wordpress.com/)
* [Tumblr]https://www.tumblr.com
Want to progress faster?
Join this learning community and try out free exercises!
Don’t miss out on the opportunity to learn a language from the comfort of your own home. Browse our selection of experienced language tutors and enroll in your first lesson now!
Start Learning Today
