В настоящее время я стажер в правительственном подрядчике, и у меня появляется (неприятно неизбежное) ощущение, что Word является стандартом де-факто в процессе разработки программного обеспечения.
Его двоичный формат очень затрудняет совместную работу с документами так, как я привык работать на основе кода. Использование простой текстовой разметки (с такими языками, как LaTeX, Markdown, ReStructured Text и т. Д. ) Позволяет создавать документы , удобные для сравнения, которые хорошо сочетаются с обычным рабочим процессом разработчика. Что касается комментариев, в которых язык их не поддерживает (например, Markdown), существует много существующих решений, которые позволяют совместно использовать комментарии на основе кода (например, GitHub, Bitbucket), которые можно легко применить к другим текстовым файлам, содержащим разметку.
Я понимаю, что необходимость сотрудничать с технологически неграмотным менеджментом требует какого-то графического интерфейса ко всему, но такие интерфейсы существуют для большинства этих форматов. Например, LaTeX имеет своего рода «форк», называемый LyX, который помещает графический интерфейс в простой текстовый, LaTeX-подобный синтаксис. Этот файл, хотя и является в основном графическим при редактировании, по- прежнему удобен для использования в разных форматах. (У него даже есть комментарии в стиле Word.) Многие из этих решений могут быть использованы вместо Word, и подавляющее большинство из них бесплатны или имеют открытый исходный код.
Тем не менее, мы используем Word даже для нашей собственной внутренней документации, которую никто больше не видит. Мы работаем с текстом для значительной части нашей карьеры - почему документация такая особенная? Помимо тривиального «Мы не знали ничего лучше, и теперь мы застряли здесь», должны быть причины, поддерживающие такое решение. С какими проблемами сталкиваются процесс разработки программного обеспечения в использовании обычного текст документации вместо других, более разговорных (и спорного менее мощных) средств написания документов?
Поскольку причины будут различаться, возможно, следует дать ответы на эти два тесно связанных сценария по отдельности.
- Использование простой текстовой документации с самого начала
- Миграция в текстовую документацию с течением времени
источник
Ответы:
Многие участники процесса разработки программного обеспечения не являются разработчиками и нуждаются в способности взаимодействовать с документацией. Должен ли QA / Marketing использовать слово, а разработчики использовать что-то еще полностью? Это было бы непоследовательным, это добавило бы еще один инструмент в цепочку обслуживания, и ИТ-отдел компании может не иметь представления о том, что делать с файлами, когда они прекрасно знают, как управлять / поддерживать хранилище текстовых документов.
Помимо всего прочего, многие не разработчики провели годы в университете, используя Microsoft Word, чтобы превратить свою работу, часто проводя практические занятия по тому, как использовать слово. Они знают это намного лучше, чем альтернативы. Я не могу понять разницу, когда я работаю в Open Office против Word, но когда моя золовка использовала его, чтобы сэкономить деньги, через неделю она заставила своего мужа купить ее Word и провозгласила: «Поскольку я получил слово, которое я люблю мой новый ноутбук! Подумайте об образе мышления, который объединяет подобные вещи, небольшое изменение в том, к чему они привыкли, не является «легким» для них.
Современное слово допускает различия версий, аннотации с отслеживанием версий, а также объединение изменений. Это может быть не так просто, как слияние кода, но я видел, что многие менеджеры проектов делают это легко, так что, конечно, разработчики тоже могут это сделать.
Кроме того, среди команд разработчиков стало довольно распространенным делом делать документацию в вики, потому что она возвращается к текстовому представлению, оставаясь при этом достаточно простой, чтобы не разработчики могли вносить изменения.
источник
Лично я думаю, что это проблема образования.
Большинство людей были обмануты, полагая, что использование такого инструмента, как MS Word, упрощает создание качественных документов, но, насколько я знаю, на самом деле это усложняет работу. Вам приходится бесконечно отлаживать форматирование и бороться со своими инструментами, чтобы получить желаемый результат.
Такие инструменты, как Scrivener, позволяют вам немного приблизиться к реальности документа без необходимости бороться с ним, как с Word. Отчасти из-за реализации WYSIWYG на самом деле не очень хорошо работает.
В моей собственной организации, чем больше людей переходят на использование MarkDown для удовлетворения большинства потребностей в документах, тем больше людей становятся счастливее и продуктивнее.
источник
expl3сообщения об ошибках гораздо более полезны :)У вас действительно есть 2 вопроса:
Первое: почему группы, не занимающиеся разработкой, не используют LaTeX или другие Markdown в процессе разработки программного обеспечения?
Проблема с переходом на LaTeX заключается в воспринимаемой кривой обучения, особенно когда вы имеете дело с нетехническими пользователями. Пользователи уже знают другие форматы и не хотят изучать другой способ делать то же, что и они. Они мало что знают о том, как различать два документа, и поэтому мало смысла переходить на текстовый формат для них. Объяснить человеку, что у вас есть решение проблемы, которую он не знал, было довольно сложно продать.
Вы также не можете недооценивать значение форвардного импульса. Чтобы перейти на новый формат, вам действительно нужно убедить других людей в вашей цепочке, что стоит инвестировать в изучение чего-то нового. Даже если вы не ожидаете, что они что-то отредактируют, потребуется время и много усилий, чтобы перейти на новый формат, если существующий формат работает (даже если плохо).
Второй вопрос: почему моя команда продолжает использовать текстовые документы, когда есть лучшие варианты, и они более чем способны их изучить?
Об этом вам следует поговорить с людьми из вашей команды. Могут быть веские причины, по которым они предпочитают сохранять текстовые документы, или это может быть просто потому, что так было всегда.
С любым изменением связаны затраты, и перевод сотен или тысяч документов в новый формат может быть дорогостоящим и длительным. Если вы собираетесь попытаться изменить свою среду, подумайте, почему вы должны изменить
источник