Можно ли использовать Документы Google для технической документации по продуктам?

Моя компания нанимает технического писателя по контракту для улучшения документации по нашему продукту. Как сопровождающий, я в настоящее время использую Google Docs и очень доволен его совместным характером (несколько одновременных редакторов, веб-интерфейс, система комментариев/ответов), простотой использования и возможностью создавать PDF-файлы.

Ресурс технического письма должен создавать/применять стандартные стили к нашим различным документам, перерабатывать/сокращать большую часть контента (мы инженеры-программисты, а не писатели), добавлять оглавления и указатели, а также разрешать вывод в веб-формате HTML (в то время как все еще позволяет нам создавать PDF). Под «удобным для Интернета» я подразумеваю стандартный контент справа и навигацию слева.

Можно ли все это сделать с помощью Google Docs? Какие есть альтернативы? Меня беспокоит переход на что-то, что не основано на облаке или ограничивает меня в проприетарном двоичном файле, который работает только в Windows или OSX.

Ответы (1)

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

Он позволяет экспортировать в .doc, .pdf и некоторые другие форматы и имеет функцию «публикации в Интернете», которую вы можете увидеть в действии здесь . Это, вероятно, не то, что вам нужно, поэтому есть также экспорт в html, который, по-видимому, позволяет вам разместить документ в другом месте.

Кажется, нет никакого контроля над тем, как навигация отображается в версии для публикации в Интернете. Публикация в Интернете и публикация на бумаге — довольно разные задачи, и Gdocs, похоже, разработан с использованием модели, ориентированной на бумагу.

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

Что касается облачной среды: я собираюсь предположить, что у вас уже есть «облако», в котором вы можете хранить свои документы: ваша система контроля версий.

Кроме того, в настоящее время Gdocs не генерирует оглавление или строки указателя.
Прикомандирован повторно с использованием вашей системы контроля версий. Это также означает, что когда вы разветвляете или помечаете код для определенных выпусков, исправлений или других усилий, ваши документы будут сопровождать код, помогая всем понять, что с чем связано.
@MετάEd Он может генерировать оглавление из стилей заголовков. См. мой пример документа.
@MonicaCellio Я собирался написать это в ответе, но вырезал его после того, как он угрожал превратиться в эссе :)
@Mr.ShinyandNew安宇 да, это было бы немного не по теме вопроса - отсюда и мое решение прокомментировать, а не предлагать редактирование. :-)
Я не уверен, что OP будет разочарован отсутствием расширенных функций; он уже очень доволен. Кроме того, проблема с VCS вполне может заключаться в сложности ее использования техническим писателем контракта.
Можно ли использовать Документы Google для технической документации по продуктам?
СпросиСетьПолитика конфиденциальности1y, 0v