Может ли программное обеспечение контроля версий использоваться для ваших технических документов?

Question

Я знаю, что вы можете использовать программное обеспечение для управления исходным кодом для исходного кода, но можете ли вы использовать его и для своей технической документации? Например, можете ли вы сохранить документ Word и хранить историю изменений (я знаю, что он отслеживает изменения, это просто пример)? Спасибо.

Answer 1

Если вы работаете на платформе Windows, то TortoiseSVN имеет некоторые действительно полезные функции, которые позволят вам различать (но, к сожалению, не объединять) документы Word. Он напрямую взаимодействует с установленным Word, а когда вы запрашиваете diff, он запускает скрипт, который загружает оба документа для сравнения в Word и использует встроенный в Word документ сравнения для сравнения.

С этой функцией в сочетании с блокировкой Subversion (где редакторы должны запросить блокировку документа для отключения флага только для чтения), я обнаружил, что очень легко управлять документами Word с помощью Subversion. Это не так удобно, как простой текст, но когда вы должны создавать документы Word, это, безусловно, выполнимо.

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

Answer 2

Системы контроля версий, хотя они могут хранить произвольные файлы, такие как документы Word, намного более эффективны для текстовых документов, редактируемых пользователем как исходные тексты, потому что различия могут быть представлены для пользователя в линейно-ориентированной форме.

По этой и многим другим причинам , я сейчас пишу всю свою документацию в reStructuredText исходных файлах, редактируемых вместе с другими исходными файлами и отслеживаемых в системе контроля версий. Версии HTML и PDF отображаются вместе с остальными сгенерированными файлами проекта во время сборки.

Answer 3

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

Answer 4

Да.

Однако учтите, что многие документы будут храниться в виде двоичных файлов. Это ограничит полезность их хранения в системе контроля версий, что затруднит просмотр детальных изменений.

Если у вас есть документы LaTeX или документы на основе XML, то все работает еще лучше.

Answer 5

Использование управления исходным кодом для технических документов - отличная идея, но, как говорили многие другие, Word - не лучший формат файла для этого.

Файл Word на самом деле представляет собой папку XML-файлов под обложками (переименуйте файл .docx в filename.zip и разархивируйте его, чтобы увидеть папку). Теоретически вы можете создать zip-папку для каждой версии, сохранить ее в системе контроля версий Git и увидеть различия в версиях. Однако это действительно непрактично и имеет ограниченную ценность.

Вы также можете использовать Pandoc для преобразования каждой версии файла .docx в Markdown и поставить файлы Markdown под контроль исходного кода.

Word также имеет встроенную функцию сравнения файлов (Обзор> Сравнить). Это разметит различия между любыми двумя файлами .docx.

Мне нравится использовать текстовые файлы Markdown или AsciiDoc для написания технических документов вместе с Git для контроля версий. Git достаточно легко научиться использовать для основных нужд. Эта система дает мне полный контроль над документом и понимание истории документа, так как она меняется со временем с каждым черновиком, комментариями рецензентов и т. Д.

Answer 6

Документы MS Word в значительной степени рассматриваются как двоичные файлы, и поэтому практически невозможно различить или объединить разные версии файла Word.

Это не значит, что он не может или не должен быть поставлен под контроль версий, просто это не поможет вам в разрешении конфликтов.

Если вы хотите этого, вы можете хранить свои документы в текстовом формате (например, .tex)

Answer 7

Я сохраняю свое резюме как документ LibreOffice в репозитории Git. Работает отлично; идея о том, что управление версиями не работает с двоичными файлами, абсолютно ложна.

Что действительно верно, так это то, что для двоичных файлов требуются соответствующие инструменты сравнения и слияния, но Git позволяет вам их указывать Я никогда не удосужился сделать это в моем случае, но утилиты diff для файлов LibreOffice / OpenOffice существуют.

Answer 8

На самом деле, решение для совместной работы MS, а именно Team System , использует SharePoint для достижения именно этого. Я почти ничего не знаю о SharePoint и с легкостью использую его для хранения версий технических документов Word.

Если вы хотите использовать его непосредственно из слова, вы можете попробовать доступную надстройку слова здесь .

Предполагая, что вы используете Visual Studio в качестве основного интерфейса для служб групповой системы, нажмите Вид-> Team Explorer. Если вы еще этого не сделали, настройте свой сервер репозитория и добавьте свой проект (для большинства этих вещей есть хорошие видеоуроки ).

Под узлом дерева проекта перейдите на Документы и создайте / добавьте свой документ. Отредактируйте его, зарегистрируйтесь и зарегистрируйтесь по желанию (и пусть ваши товарищи по команде сделают то же самое). Если вам нужна история версий документа, откройте ее из окна командной строки . В приложении Word, которое будет запускаться, у вас должна быть (по умолчанию) справа панель «SharePoint». (Я пишу это без доступа к клиенту команды, но я почти уверен, что не делаю никаких неисправимых ошибок ...). В нем перейдите на вкладку info и прокрутите вниз до 'History ...' (или это Versions ... ? Точные детали завтра. )

Answer 9

Как и все остальные, вы можете использовать контроль версий для своей технической документации. Но я определенно собираюсь перейти к той стороне плаката, которая предложила реструктурированный тест. Весь смысл контроля над ревизиями состоит в том, чтобы видеть различия и объединяться между ними, и в моей книге вам понадобится использовать текстовые файлы для этого.

Некоторые другие параметры, кроме restuctureText: DocBook и DITA . Они довольно популярны в мире технических публикаций и основаны на XML, поэтому для них есть несколько приличных инструментов поддержки. Для DocBook вы можете проверить XML Mind .

Answer 10

Да, вы можете. Вы можете загружать файлы в систему управления версиями и хранить для них историю изменений.