Size: a a a

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

2021 August 13

NP

Nikolaj Potashnikov in DocOps-сообщество
Левый термин — это термин, который присутствуют в терминологическом списке, но отсутствует в тексте. Если с терминологическим списком всё понятно, то вот для определения термина в тексте можно придумать варианты. Самый простой, видимо, роль. Ну и что-то изобрести с терминами в неименительном падеже и вообще отсутствующими в тексте. Что угодно, т.к. таких обычно не много. Далее xpath + несколько строчек кода. Но! мы говорим именно о тестировании того, что документ получился правильным. Как верно отметили коллеги, а можно ли помочь тому, кто пишет документ?
источник

NP

Nikolaj Potashnikov in DocOps-сообщество
Вообще тесты документации похожи на e2e тесты. Когда они валятся... это ещё пойми, где править
источник
2021 August 14

ИЦ

Игорь Цупко... in DocOps-сообщество
Левый термин - это тот, что отсутствует в списке но присутствует в тексте.

Договорились писать везде Колобок, но люди пишут что попало: Хлебобулочное Изделие, ХИ, объект К, Шар Из Мякиша.
Надо привести к единому виду.
источник

NP

Nikolaj Potashnikov in DocOps-сообщество
Да, эти тоже левые)) чем плох предложенный в статье подход? Я там как раз заставляю себя не использовать слово "нужно" и его формы
источник

NP

Nikolaj Potashnikov in DocOps-сообщество
assert_nil File.read('statqya.spell').match('[Нн]ужн'), "Нужн... -> Необходим..."
источник

ИЦ

Игорь Цупко... in DocOps-сообщество
Отсутствием на старте всего списка альтернативных левых терминов) если их все знать - решений несколько придумать можно.
источник

NP

Nikolaj Potashnikov in DocOps-сообщество
Но оно ж на то и регрессионное тестирование, что на старте всего не знаем. Человек человеком сложно предсказуем. Главное, чтобы шар из мякиша был первым и последним)
источник

XM

X Man in DocOps-сообщество
О, привет! Я правильно понимаю, что вы заморачиваетесь по документации?
Собственно, я думаю сейчас над процессом. Собираю сейчас идеальный темплейт с автогенерацией сайта с документацией. Как думаете, для фулстека на джээсе с реактом норм выбрать jsdoc + react-styleguidist + swagger?
источник

NK

ID:0 in DocOps-сообщество
Отличная иллюстрация когнитивного искажения, называемого «проклятием знания».

https://m.xkcd.com/2501/
источник

ОS

Олег SoftFAN in DocOps-сообщество
Чем больше знаешь,  тем больше не уверен в своих знаниях.
источник

NV

Nick Volynkin in DocOps-сообщество
И это тоже. Но проклятие знания — это про другое. Когда много знаешь в какой-то области, то забываешь, как мало о ней знают другие
источник

ОS

Олег SoftFAN in DocOps-сообщество
Вот и остается только разбрасываться знаниями… вдруг еще где-то прорастет…
источник

АП

Алексей Пахомов... in DocOps-сообщество
Добавим сюда лестницу винтгенштейна и даннинга Крюгера для полноты картины
источник

I

Igor in DocOps-сообщество
Да, и тогда уж напомним что Данинг-Крюгера ещё до того как типа задебанкнули все неправильно интерпретировали потому что не читали исходную статью
источник
2021 August 16

XM

X Man in DocOps-сообщество
Ребята! Кто знает в Jekyll как решить проблему с путями на локали? Он всегда ставит по умолчанию пути c / в начале. Линукс интерпретирует это как путь с корня файловой системы.  baseurl: "" или "./" не помогает =( Кто знает что делать?
источник

a

arvikon in DocOps-сообщество
А ссылки в исходниках со слеша начинаются? Т.е. [page](/link/to/page). Тогда он будет отталкиваться от урлы или базовой урлы. Ну это если через джекилл серв.
А если сбилдил, а потом полез руцями хтмл открывать, то там беда будет всегда -- тут можно попробовать костыль -- https://ricostacruz.com/til/relative-paths-in-jekyll
источник

XM

X Man in DocOps-сообщество
Спасибо! Подумаю. Хочется что-б в репе дока тоже лежала и её можно было бы открыть на компе.
источник

NP

Nikolaj Potashnikov in DocOps-сообщество
Ещё в дополнение этой мысли, мне кажется это важно. Может сложиться такая ситуация, что выловленный термин уже разошелся по документации и, если включить его в запретный список, придётся менять всё. Но тут есть отличный паттерн храповика. Каждый коммит не должен увеличивать количество ошибок. Т.е. ввели правило, оно увеличило количество ошибок до 1000. Поменяли настройку храповика и работаем дальше
источник
2021 August 17

АВ

Алексей Волков... in DocOps-сообщество
Всем добрый день.
Возможно здесь такой вопрос обсуждался, но все же.
Скажите пожалуйста, кто то сталкивался с системами  электронного ознакомления с приказам/документами через ЭЦП?
Спасибо.

P.S. Можно в личку
источник

RG

Ramil G in DocOps-сообщество
у нас в боссреференте сделано. При трудоустройстве сотрудник подписывает соглашение о том, что учетная запись (логин, пароль) в СЭД является простой подписью, достаточной для внутреннего документооборота. После этого отпадает необходимость внедрять криптографические ЭЦП для СЭД
источник