📜 ⬆️ ⬇️

Stackoverflow launches Documentation section

Yesterday there was a significant event in the development market. More precisely in the field of support and maintenance of software products. StackOverflow has launched a documentation section. Why is it important?


Over the past years, when github captured the source distribution market, the documentation problem has been acute. Despite the convenience of working with the code, github could not offer a decent documentation system - the wiki is abandoned, and it is simply too time consuming to keep them through cvs. ReadTheDocs tried to solve this problem, clearly did not commit a coup, going to the problem in the forehead. There is also a gitbook, but it can hardly be called a standard.


Today, there are the following problems faced by developers:


  1. The lack of a convenient way to maintain multi-page documentation with complex navigation.
  2. The need for interaction of many authors.
  3. The lack of a unified style of paperwork. Take the same Mongoose documentation - annoying colors, poor syntax highlighting.
  4. The need to choose a place for storage and distribution.
  5. Paperwork problems in their own right.

Judging by what StackOverflow offers, we will get an interesting tool to solve the above problems and to make keeping records a simple process. Of the possibilities:


  1. Joint development with support for comparisons (diff).
  2. Request to create an article.
  3. Vote for changes, instead of a single author.
  4. Standard stackoverflow promotion system.

It remains to hope that soon we will have more quality documentation and dreary and for some unpleasant the process of its management will finally become pleasant.


')

Source: https://habr.com/ru/post/306234/


All Articles