Кто должен писать документацию?

6yrop

Документация -- это какой-то текст, который поможет поддерживать и развивать систему другим разработчикам.
Что по вашему мнению должно входить в такую документацию?
Должны ли программисты писать документацию?

evgen5555

Программисты точно не должны. Они должны проверять. А пишут обычно технические писатели.

maggi14

Есть такая специальность - документоведение.
В документацию должны входить:
а) выходные данные, копирайты, дисклеймеры и пр.;
б) общие ТТХ;
в) спецификация;
г) рекомендации;
д) и прочая подобная инфа.
Прогеры писать документацию должны только в том случае, если фирма обычно софт не пишет и, соотв-но, не имеет штатного техписателя.

malya

имхо лучая документация для разработчиков для поддержания и развития системы - нормальные комменты.
ну вводные слова и общие концепции тоже не впадлу один раз написать

6yrop

а програмеры должны устно рассказывать техписателю, как они программировали?

Marinavo_0507

жестами
без этого не поймут

maggi14

Нет, программеры должны программировать по ТЗ

6yrop

имхо лучая документация для разработчиков для поддержания и развития системы - нормальные комменты

пробовал я и коменты писать, вообщем, тоже хрень какая-то получается, из кода и так всё видно, иногда даже лучше

6yrop

я вот думаю, необходимо изложить основные идеи и подходы, которые использовались (у нас это несколько страниц а остальное всё из кода легче посмотреть

malya

и все же когда первый раз видишь код гораздо приятней когда вначале написано краткое описание файла, а перед функцией хотя бы что она делает

6yrop

описание файла

ты что подряд файлы читаешь?

перед функцией хотя бы что она делает

а название метода и параметров на что, часто в бизнес-приложениях этого хватает

malya

а название метода и параметров на что, часто в бизнес-приложениях этого хватает

иногда не хватает, не знаю как в бизнес приложениях - не видел сырцов, но всякие гнутые и прочие сырцы порой очень сложно понять - год назад ковырял gcc - первое время вообще ниче понять невозможно было

sergey_m

Программисты точно не должны. Они должны проверять. А пишут обычно технические писатели.

Документацию конечного продукта.
А скажем документацию внутренних интерфейсов должны писать сами программисты.

anton7805

согласен,еще бы не плохо использрвать SoDA или еще че -нить,чтоб каменты автоматически заносились в правильную форму.В java есть javadoc ,который очень помогает программерам не терять много времени на самое нелюбимое занятие- написание документации

krishtaf

все зависит от процесса разработки.

sergey_m

Хуёв тот программер, кто не любит писать документацию.

durka82

По-хорошему документация должна генериться по исходному коду (то есть в нем должно быть достаточно информации об этом).
Но всю документацию вроде как так все равно не создать - остальную часть должны делать аналитики, наверное
Что-то подобное сделано в Together.

daru

+1