Technical Documentation

In the tech industry, it's not uncommon for developers to work on project maintenance. You could be asked to fix a few bugs in a system which is already in production and has a user base. Or to add new features, or to refactor.

First and foremost we should agree on the definition. I understand self-documenting code as a code that can not be possible made any more transparent by adding new textual artifacts to it that are not code. Is this ok? Now I want you to see this. Three lines.

Six months ago, I joined NNIT and embarked on my journey as a Graduate. So far the journey has been incredible and I'm just about to start my second module in a new department. Being a graduate is rather different from joining a company in a specific position.

What makes how people think different from how computers think is our use of concepts. Reading the news doesn't simply tell me that tell me that a drinking wine might not be as good to our health as we previously thought ( Red Wine is bad for you Say Experts).

" Any fool can write code that a computer can understand. Good programmers write code that humans can understand. " - Martin Fowler Yes, your must never write code for yourself and that is what I was doing while working on infrastructure and APIs development.

Codex is a file-based documentation platform built on top of Laravel. It's completely customizable and dead simple to use to create beautiful documentation. Codex is able to do things like transforming markdown or automaticaly fetching documentation from a Bitbucket/Github repositories. Most of it's features are provided by addons.

As you know, Agile Manifesto claims "working software over comprehensive documentation". So you might get the impression that Agile methodology rejects all documentation. Then you are wrong. We will provide a brief overview of the best practices of Agile documentation. Yes, indeed static documentation is too rigid for Agile.

Documentation is an oft-neglected area of software development and it has a reputation for being inscrutable to the common man. Definitions like this inform many people's inaccurate view of software documentation. Does anyone really read the manual, and do manuals even exist for most SaaS software?

Perfect documentation should be: Yes, you see correctly only one point.It should be auto-generate as much as it is possible to be good. Who works on the project - I don't want to provide this information by hand.

I've been playing around a lot with API design lately because I have an API project coming up at Argu. But one of the things missing a lot from the design standpoints was one of the (in my opinion) most important aspects, the documentation.