jourmager
Advanced Member | Редактировать | Профиль | Сообщение | Цитировать | Сообщить модератору
Цитата:| Я правильно понимаю, что вы тщитесь доказать, что документация не нужна? Если так, то это прорыв в программировании! |
А причём тут "программирование"? Документация в программировании, т.е. написании кода - это комментарии в тексте программы и самодокументирующийся код, плюс тёмные материи типа Clean Code. Т.к. проект СканКромсатор проприетарный, то судить мы об этом не можем.
Если же речь идёт о программной индустрии, то документация обычно делается на отвали. Форумы и онлайн хелпы туда же. Монстры типа Майкрософта или Адоба сваливают проблемы написания нормальной документации на сторонних тек-райтеров и ютуберов, не забывая выпускать при этом книги под собственным брендом.
В случае свободного ПО проблема документации (её отсутствия) решается ограничением количества функций и созданием интуитивно понятного интерфейса в рамках индустриальных стандартов. Ну это когда есть сотня просмотрщиков графики типа ACDC, Xnview, Irfan, то сделать ещё один с понятным интерфейсом не проблема. Даже если интерфейс корявый, то так принято.
А что делать, если программы с такими функциями одна в своём роде? И функций наворочено выше крыши? Конечно, можно сказать, что аналоги у СканКромсатора есть - СканТейлор, БукРесторер, LIMB Processing, но функционально СканКромсатор намного богаче, т.е. даже простое описание кнопок займёт толстенный талмуд.
Также не надо забывать, что написание хелпа или туториала достаточно непростая задача, об которую спотыкаются даже опытные тек-райтеры, что уж говорить о программисте, которому интересно решение задачи, алгоритмы, а не скучное протоколирование кнопок и менюшек.
Если же вернуться к проблеме отсутствия документации у СканКромсатора, то один из путей решения - это создание двух хелпов-туториалов:
1а) простое описание программы, логики её работы, интерфейса
1б) пошаговый разбор типичного случая, который покрывает 80% книг, причём типичный случай должен быть тщательно подобран и даже сделан искусственно
2) пошаговые (или нет) разборы сложных случаев, что-то типа Q&A
Частично это уже было в Хрестоматии, но с ней было 5 проблем:
1) разные авторы - разный подход
2) одно и то же мусолилось 4 раза
3) примеры не очень-то характерные
4) часть информации уже устарела и какие-то операции делаются иначе
5) новых функций нет вообще. т.к. ей уже 6 лет и было выпущено десяток новых версий СК.
Но тут есть вопрос - а кому нужна документация? "Старики" уже и так всё знают, а что не знают - спросят у автора и получат ответ (пока его это не задолбало), "молодежь" привлекать никому не интересно и она просто уходит в СТ или ФШ, а если кого-то задолбало ограничения СТ и он хочет свитчнуться в СК, то флаг ему в руки, может ему проще плюсы выучить и клон СТ зарелизить. |
