(Untitled)

[squadette]

Программист, заступая на новую работу, каждый раз искренне изумляется и негодует, что "система не документирована". Это негодование - по своей силе бледное подобие негодования второго рода, которое тот же программист испытывает, если ему предложить описать простым человеческим языком, что он недавно наколбасил. И не забывать регулярно обновлять

Comments

[1master]

А разгадка одна: безблагодатность документировать нужно продукт, а не код.

[prepor]

Это хуита, ты же понимаешь. Просто хорошо выглядит за счет "негодования второго рода".

Даже в нашей (!!!) конторе пишется актальная дока на API которое использует один человек.

[levgem]

На какое API???

[squadette]

Андрюша, ну о чем ты.

В нашей компании работают монстры

[vaddimka]

Лучшая документация это код. Код должен быть понятно написан и спроектирован. И я реально видел такие системы.

Единственно, иногда полезно прочитать пару строк про то что эта вся хрень делает. В том плане что то что делает код и так видно, но не всегда сразу видно зачем.

[dr_del]

вот пример "негодования" на просьбу описать простым человеческим языком))
switch ($data['extra']) {//тут начинается уличная магия, постичь которую можно только в монастырях шаолинь в течении 86 лет. Поэтому переписываем как есть.