Недобре документиран код? Проблемът не се крие във вашите програмисти, а във вашият процес.
Намирането на най-добрите разработчици, които да се присъединят към вашия екип е достатъчно трудно. Намирането на тези, които документират своя код, може да изглежда като едно малко чудо. Нека игнорираме документацията за потребителите за сега.
Наръчниците и справочниците са все още най-добрите помощници на техническите писатели – професионалисти, които се специализират в превода на технически характеристики. Този вид документация идва по-късно. По време на процеса на разработка на софтуер, обаче, поддържането на добра структура на документацията за вътрешна употреба е от съществено значение.
Екипите за разработка на софтуер непрекъснато се изменят. Програмистите могат да променят работните места, да променят отдела в който работят или да се пенсионират. В най-лошия случай при заболяване или непредвидено отсъствие, поради някаква причина разработчиците могат лесно да забравят как техният собствен код работи, ако не са се занимавали с него повече от седмица. Във всеки от тези сценарии написаната документация, която позволява на другите разработчици да продължат проекта е спасителния пояс, за спазване на крайните срокове. API спецификации, ръководство на страници, както и коментарите на кода спестяват много време в лутане и разбиране на програмната логика. За съжаление, твърде малко разработчици документират детайлно работата си или по определения стандарт. Да ги приучите към този систематизиран начин на работа е трудно, но не и невъзможно.
