Size: a a a

technicalwriters

2021 May 25

OA

Olga Alexeeva in technicalwriters
всем привет) кто может подсказать, как ставить якорные ссылки в режиме редактирования в gitbook? Я имею в виду ссылки на разделы в других статьях. Что-то видела в режиме просмотра, но я всегда работаю в режиме редактирования.

Я недавно начала работать с этим инструментом, поэтому вопросы есть, а в документации их не на всё нашла ответы)
источник

SR

Stas Rychkov in technicalwriters
Не так случаем?
[heading](../chapter2/test.md#h5)
источник

OA

Olga Alexeeva in technicalwriters
а можешь пример подробнее расписать, пожалуйста? я что-то не поняла про test.md#h5 🤔
источник

D

Daria in technicalwriters
Подозреваю, что путь_к_файлу.md#название_якоря
источник

OA

Olga Alexeeva in technicalwriters
так у меня что-то не получилось, но благодаря этому я поняла, как делать)

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

почему-то до этого у меня так не отображалось))
источник

D

Daria in technicalwriters
главное что помогло!
источник

OA

Olga Alexeeva in technicalwriters
это точно, спасибо))
источник

SR

Stas Rychkov in technicalwriters
Ура. Хорошо, что работает, и спасибо, что отписались.
источник
2021 May 26

E

Ekaterina in technicalwriters
Добрый день! Я вот прям совсем-совсем новенькая в профессии технического писателя и мне нужен совет опытных коллег. Мне нужно разработать спецификацию требований. Подскажите, какой инструмент для этого лучше использовать? Чтобы в последствии с этими требованиями было удобнее работать (изменять, согласовывать, дополнять) и при этом создавать продукт согласно этим требованиям.
источник

BF

Bobba Fett in technicalwriters
Гугл докс
источник

E

Ekaterina in technicalwriters
Там нет возможности связывать требование с задачами для разработчика и исходным кодом;
источник

D

Dmitriy in technicalwriters
А какое связывание ожидается? Ссылку поставить?
источник

E

Ekaterina in technicalwriters
Да. Хотя бы ссылку на эпик или задачу в jira
источник

ДЧ

Дарья Чернавина... in technicalwriters
Мб через git как-то?
источник

D

Dmitriy in technicalwriters
Ну по-моему в гуглодоках поставить гиперссылки не проблема... Пишите Вики если так хочется связывания
источник

E

Ekaterina in technicalwriters
Я наверное еще сама не очень понимаю, что хочу. Но я хочу создать документ в некой среде, чтобы из него можно было сформировать текстовый документ или pdf, или статью в wiki. При этом чтобы он был разрабатывался и изменялся только в этой среде. И чтобы заинтересованным людям приходили уведомления об изменении, и сразу было понятно, что и программистам нужно поставить задачу. И если еще и в git можно залить, то вообще супер.
источник

E

Ekaterina in technicalwriters
что-то вроде doors, но попроще
источник

IC

Ivan Cheban in technicalwriters
Confluence. Там можно вставить ссылку на задачи в джире. И это вики, где все могут редактировать статью. И есть история версий. И экспорт в пдф, хоть и немного кривой.
источник

ОS

Олег SoftFAN in technicalwriters
Возможно, для этого wiki в Redmine, (можно и задачи и коммиты в git подвязать,  история есть, экспорт возможнен) подойдет, но это как бы не разу не среда управления требованиями типа Doors. И слабее чем confluence с jira. Но бесплатно.
источник

NK

Nata Kazakova in technicalwriters
посмотрите на https://www.mkdocs.org. у нас внутренняя дока на нем крутится. генерит статичный сайт по md файлам в гитлабе, то есть полнофункциональная система контроля версий. можно добавить плагинов для экспорта, мы не используем, но я только что нагуглила несколько. довольна популярная вещь, плагинов много.
источник