четверг, 17 сентября 2009 г.

Документация в IT

Что же такое документация?
Постараюсь с улыбкой на лице ответить на этот вопрос :)
Итак:

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

Плохая документация - это то чем можно в итоге подтереться.

Хорошая документация - это то что не стыдно показать другим и выложить в открытый доступ в интернете.

Хорошая документация может легко стать плохой, если не следить за ней (не поливать 3 раза в день, не вытирать пыль на листиках, не удобрять, не пересаживать в новую землю...)

В дальнейшем попробую дополнить список... Кстати, а что вы можете сказать про документацию?

4 комментария:

Алексей Лупан комментирует...

Ооооо, сколько хочется всякого сказать на эту тему. Но так кратко, смачно и емко - увольте, не смогу :)

Алексей Лупан комментирует...

А вот хороший хулиганский ответ на "кто пишет документацию?" - кому надо, тот и пишет... :)

Александр Селяев комментирует...

ммммм придерживаюсь мнения что любой документ может быть в двух видах:
1) продукт который нужно продать (клиенту, начальству, соседу...). Это красиво оформленный, вдумчивый толмуд с картинками настолько сложными чтобы пользователю понравилось.
2) информация которая помогает в работе. Формат может быть любой - наборы RFC, wiki, тот же толмуд но с картинками простыми и обновляемыми.

Иногда случается, что такие формы даже вместе встречаются. Я помнится сам даже такие доки готовил. Потому как сам же и работал по ним. ж-)))

Vita комментирует...

Когда внедрялась наша система, мне велено было написать технологию в виде красивых схем с описанием, сравнивая реальную технологию и автоматизированную и рассмотреть перспективы развития.
Главный и основной плюс по этому документу (благодатной почве) - я в этом хорошо разобралась (в технологии), а документ был далее только однажды применен для обучения нового начальника-пользователя ПО

Условия копирования публикаций:

Все публикации в данном блоге являются частной собственностью авторов. Любое копирование информации допускается только при условии указания имени автора и активной ссылки на источник.