Кстати говоря.... техпис писатель, техпис не проверятель. Как вы проверяете свою

Question

Технические писатели

Марина

Кстати говоря.... техпис писатель, техпис не проверятель. Как вы проверяете свою

же документацию? На что именно проверки и как вы их делаете?

0

04.09.2023

7 ответов

12 просмотров

Марина Автор вопроса

Aleksandr Simonov
на здравый смысл, орфографию и применимость в жизн...

А где сквозные проверки? Чтоб единообразие было? А где сверки частей одного документа с частями других документов?

0

04.09.2023

Vasilisa N

Марина
А где сквозные проверки? Чтоб единообразие было? А...

Тут уже должна включиться служба качества: нормоконтроль и прочие. Которые ведь тоже предусмотрены ещё с незапамятных времен

0

04.09.2023

Марина Автор вопроса

Vasilisa N
Тут уже должна включиться служба качества: нормоко...

Не во всех конторах есть отдельные нормоконтролеры. Если отдельных нет, то и проверять не надо?

0

04.09.2023

Vasilisa N

Марина
Не во всех конторах есть отдельные нормоконтролеры...

Может не быть отдельного человека - нормоконтролера, может не быть системы менеджмента качества, но их функции никуда не денутся, значит их осуществляет кто-то другой?... В общем и целом: единые стандарты к написанию - будет и единообразие. Требования к документированию самого процесса написания документации (тут уже можно застрелиться, но этого часто не хватает). Другой что-то пишет, ты что-то пишешь, потом выясняется, что Вася и Петя писали +/- про одно и то же... И все написали разное)) Что про нк, что про систему качества документированной информации много всего написано

0

04.09.2023

Марина Автор вопроса

Vasilisa N
Может не быть отдельного человека - нормоконтролер...

Этим кем-то может же быть техпис?

0

04.09.2023

Дарья Курнаева (Чернавина)

Марина
А где сквозные проверки? Чтоб единообразие было? А...

Согласна, проверок куча, столько же, сколько критериев документации как минимум. 1. Полнота, точность, актуальность (все необходимые сведения для выполнения действия); 2. Понятность и соответствие ЦА; 3. Соответствие глоссарию и стайлгайду; 4. Структурированность, последовательность, логичность; 5. Удобство использования (можно быстро найти всю нужную инфу); 6. Консистентность (единообразие во всём). И т.д.

0

04.09.2023

Aleksandr Simonov · Accepted Answer

Aleksandr Simonov

на здравый смысл, орфографию и применимость в жизни) а на соответствие реализации это пускай тестирование проверяет)

0

04.09.2023

Похожие чаты

Кстати говоря.... техпис писатель, техпис не проверятель. Как вы проверяете свою

7 ответов

Похожие вопросы