Почему важна актуальность технической документации?

Категория: Технические советы

– Автор: Игорь (Администратор)

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

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

Дело в том, что даже чисто математически с каждым добавленным элементом самый простой перебор комбинаций увеличивается в 2 раза. Скажем, если у вас 2 кнопки в программе, то комбинаций всего 2: первая-вторая и вторая-первая. Когда же элементов 100, то это уже 2^100 (2 в сотой степени) = 1 267 650 600 228 229 401 496 703 205 376 различных комбинаций.

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

Второе - взаимосвязь между элементами может быть неочевидной и сложной.

Допустим, вы используете некий импорт данных из электронных таблиц экселя (xls, xlsx) или опенофиса (ods). И в какой-то версии программы появляется необходимость добавлять какую-то дополнительную колонку с идентификаторами. Сделано это было для того, чтобы оптимизировать импорт данных (Разве не полезно? Полезно! Ведь приложение будет быстрее выполняться и вам не придётся ждать!). Однако документацию к программе никто не актуализировал. Как пользователь узнает о том, что ему обязательно необходимо добавлять колонку в таблицу для импорта? Никак. И даже догадаться никак не сможет, если программа не будет выдавать соответствующие сообщения.

Аналогичное касается и многих других вещей: различных названий элементов, изменений в порядке нажатия кнопок и тому подобного. Суть очень проста - обычные пользователи не разбираются в приложении на том же уровне, что и их авторы. Поэтому многие вещи, которые очевидны для авторов, будут неочевидными для обычных пользователей.

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

Суть в том, что в момент, когда вы "варитесь" в основной деятельности, все мелочи, детали, нюансы у вас как бы "учитываются" в голове. Но когда проходит время, то такие вещи обычно отходят в сторону. Поэтому если возникает ситуация, когда нужно в чём-то разобраться или что-то доделать, то автор приложения становится таким же обычным пользователем, как и тот из предыдущего пункта. И если что-то в документации неактуально, то он легко может сделать некорректные выводы, что обычно и приводит к проблемам. Скажем, если в приложении были убраны какие-то функции или изменены внутренние механизмы, но это не описано в документации, то это может быть критичным.

Четвертое - отсутствие актуальной технической документации снижает доверие пользователей к программе.

Простой пример. Скажем, вам нужно какое-то сложное приложение и вы хотите посмотреть как реализована та или иная функция. Открываете документацию, затем смотрите программу и видите несоответствие. Естественно, вы можете уточнять детали у авторов приложения, но внутри возникает вполне логичный вопрос "А как дальше справляться с проблемами, если документация не соответствует?". Т.е. в любой момент времени вы открываете документацию и понимаете, что существует немалый шанс того, что вам придётся обращаться в техническую поддержку. А какой тогда смысл в такой документации?

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

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

Также вам могут быть интересны обзоры:

1. Зачем нужно поддерживать актуальность на сайте?

2. Нужно ли включать короткую справку внутри программного продукта?

3. Универсальное или уникальное решение: что лучше?

4. Закулисье технической поддержки: на что обращают внимание?

5. Как правильно задавать технические вопросы?

Понравилась заметка? Тогда время подписываться в социальных сетях и делать репосты!