Size: a a a

DocOps-сообщество

2020 August 13

RG

Ramil G in DocOps-сообщество
Fox Mulder
Коллеги, может кто занимался:
Есть перечень атрибутов для аскидока. Этим атрибутам присваиваются значения.
Как сделать так, чтобы этот заранее предопределённый набор автоматически распространялся на  все создаваемые adoc в независимости от среды разработки, операционной среды и т.п.
То есть, должен быть какой-то conf-файл, который должен содержать требуемое и который можно рассылать.
Или копать в сторону gradle(maven)?
подключайте этот конфиг инклюдом
источник

FM

Fox Mulder in DocOps-сообщество
Ramil G
подключайте этот конфиг инклюдом
Спасибо большое! Помогло.
источник

NK

ID:0 in DocOps-сообщество
Тоня шарит! Мне тоже помогает такое.
https://t.me/Editors_cave/158
источник

I

Igor in DocOps-сообщество
О, а я использую трюк писать какое-то слово по вертикали и делать так что каждый новый абзац/предложение начинается со следующей буквы этого слова.
источник

СФ

Семён Факторович... in DocOps-сообщество
да-да, любой мануал можно начинать со слов «наша хренотень работает вот так...»
источник

СФ

Семён Факторович... in DocOps-сообщество
главное — не забыть их стереть перед отдачей на ревью
источник

NV

Nick Volynkin in DocOps-сообщество
начинать с заголовка "Ворк ин прогресс, йопта"
источник

NV

Nick Volynkin in DocOps-сообщество
На сайте у Тома Джонсона вижу баннер «Reduce the time it takes you to publish documentation by up to 60%». Думаю, вот и что нам дали бы эти несколько минут? Нам и так норм.
источник

НН

Нац Нац in DocOps-сообщество
внатуре, пустил публикацию и забыл, главное шо опубликовано, хоть полчаса пусть заливается
источник

NV

Nick Volynkin in DocOps-сообщество
В нашем случае замержил пуллреквест и забыл, но суть та же.
источник

ИЦ

Игорь Цупко... in DocOps-сообщество
это у вас документация 40 минут не катится....
источник

ЕД

Егор Доронин... in DocOps-сообщество
И что же они все предлагают делать с сэкономленным временем?)
источник

ЕД

Егор Доронин... in DocOps-сообщество
Доки не код, quality gates не проходят
источник

ЕД

Егор Доронин... in DocOps-сообщество
Continuous Deployment всегда, а не Delivery
источник
2020 August 14

NV

Nick Volynkin in DocOps-сообщество
Егор Доронин
Доки не код, quality gates не проходят
ну мы тестируем до мержа, это считается quality gates? Вообще, впервые слышу этот термин, пойду почитаю про него.
источник

ЕД

Егор Доронин... in DocOps-сообщество
SDLC - Software Development Life Cycle
источник

IK

Igor K. in DocOps-сообщество
всем привет,
кто нибудь использует в работе чеклист по нефункциональным требованиям?
источник

NV

Nick Volynkin in DocOps-сообщество
Варя, привет!
источник

IK

Igor K. in DocOps-сообщество
чтобы перед началом проекта описывать эту часть требований
источник

NV

Nick Volynkin in DocOps-сообщество
Igor K.
всем привет,
кто нибудь использует в работе чеклист по нефункциональным требованиям?
Вот вроде такого? https://t.me/docops/91
Telegram
DocOps
​​Как подумать и написать обо всём, что важно

Представьте, что мы с вами придумываем новую фичу и пишем о ней документ (vision, SRS, ТЗ). Именно по этому документу дизайнеры придумают интерфейс, разработчики напишут код, а тестировщики проверят, всё ли получилось правильно.

Нам нужно обдумать и описать несколько аспектов фичи: интерфейс, безопасность, GDPR и другие. Держать всё это в голове довольно сложно.

Кажется, что задачу можно упростить шаблоном документа с заголовками секций про каждый аспект. Но бывает, что для фичи X неактуален аспект Y. Например, она не меняет интерфейс. Что тогда делать с заголовком из шаблона?

✘ Удалить заголовок. Читатель не поймёт, забыл автор про это написать или сознательно убрал.
✘ Оставить заголовок, ничего не писать. Так точно будет впечатление, что автор забыл.
✘ Оставить заголовок и написать «Это неприменимо или не имеет значения для этой фичи». Это засоряет документ и усложняет работу читателя.

Все варианты плохи. Ещё сложнее делегировать разработку фич и написание…
источник