📜 ⬆️ ⬇️

Design problem of text design.

A postmoderation system for content is being implemented on the Webcam. There is a large design document that describes the entire process architecture. It is planned to make a squeeze out of it, which needs to be turned into an instruction for several groups of people:

1. Moderators - those who work directly on the content. Use the document as a guide to action.
2. Programmers - those who support and develop the system. New programmers should quickly understand how everything works. Naturally, after they become familiar with the internal rules of writing code and the framework.
3. Analysts - those who view the moderators' reports and think over the logistics for the system.

It is clear that the document will constantly change, so I don’t really want to support three copies. It will be just a mess in view of the human factor.
')
Therefore, the question! How to make a document so that it does not frighten moderators, is useful for programmers and convenient for analysts?

Authors of good ideas (using only with their consent) will be noted on our wiki, and are occasionally mentioned in press releases.

And personally from our team - Respect to karma :)

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


All Articles