История изменений
Исправление Zhbert, (текущая версия) :
Чтобы написать хорошую документацию нужен хороший специалист, умеющий писать связный текст. Таких еще называют «технический писатель». Причем это должен быть не просто чел, который умеет в текст, а еще и инженер, который понимает, о чем он пишет. Вот только тогда дока будет нормальная. Но зачастую доку пишут инженеры, а у них свое видение того, «как надо», что ожидаемо на выходе будет понятно только им или инженерам такого же уровня. И они часто вообще не умеют писать связный текст. А еще много где даже не знают, что бывают техписы, а если и знают, то забивают болт на найм таких специалистов.
Исходная версия Zhbert, :
Чтобы написать хорошую документацию нужен хороший специалист, умеющий писать связный текст. Таких еще называют «технический писатель». Причем это должен быть не просто чел, который умеет в текст, а еще и инженер, который понимает, о чем он пишет. Вот только тогда дока будет нормальная. Но зачастую доку пишут инженеры, а у них свое видение того, «как надо», что ожидаемо на выходе будет понятно только им или инженерам такого же уровня. А еще много где даже не знают, что бывают техписы, а если и знают, то забивают болт на найм таких специалистов.