Size: a a a

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

2019 October 16

FM

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

FM

Fox Mulder in DocOps-сообщество
Понятно, что как-то можно прикрутить оформление по ГОСТ к rst там или md.
А вот исправить синопсис - сомневаюсь.
источник

NV

Nick Volynkin in DocOps-сообщество
пошёл читать, что такое синопсис
источник

AY

Andrei Yemelianov in DocOps-сообщество
Nick Volynkin
пошёл читать, что такое синопсис
я тоже
что такое синопсис применительно к техдокументации?
источник

СФ

Семён Факторович in DocOps-сообщество
Fox Mulder
Все хорошие техписы в той или иной мере обучены и кодить и конфиги писать. Это и отличает высокооплачиваемого специалиста от среднего или начального уровня.
Я думаю никто, в текущих реалиях, не будет платить техпису хорошие деньги если он просто набирает текст.
Например, техпис обязан сам развернуть среду разработки документации на основе сфинкса+рст; иметь и знать вывод через апач-фоп и тд и тп
Но! Вот просто жирный но, который я всегда приношу в такого рода обсуждения, применимое в условиях России. И связано это Но с тем, что даже крупные ИТ-компании вынуждены писать документацию или согласно ГОСТ или валидируя в ФСТЭК.
А такой подход не предполагает использование подхода к документации как к сервису или коду ,а значит от технического писателя требуются уже другие компетенции, и ему совершенно не нужно уметь в докер; зато вот знать ФТБ или РВ более полезно.
Что же касается доли именно госдокументации - она огромна. Яндекс, Маил, Касперский - все пишут доки именно такого плана. Что же говорить о компаниях поменьше.
Зачем компании техпис, который может в docasacode, когда его Изделия надо офрмлять согласно РВ.
))
в Яндексе, Мэйле и Касперском пишется огромное количество не-ГОСТовской документации

собственно, все техписатели из этих компаний, с которыми я общался (суммарно 30-40 человек), НЕ занимались ГОСТами

у меня нет взвешенной и полной статистики вида «компания Х пишет 30% документации по ГОСТу, а 70% — не по ГОСТу», но для тех трех компаний, которые вы упомянули, соотношение точно не 100% к 0%.
источник

AY

Andrei Yemelianov in DocOps-сообщество
Fox Mulder
Все хорошие техписы в той или иной мере обучены и кодить и конфиги писать. Это и отличает высокооплачиваемого специалиста от среднего или начального уровня.
Я думаю никто, в текущих реалиях, не будет платить техпису хорошие деньги если он просто набирает текст.
Например, техпис обязан сам развернуть среду разработки документации на основе сфинкса+рст; иметь и знать вывод через апач-фоп и тд и тп
Но! Вот просто жирный но, который я всегда приношу в такого рода обсуждения, применимое в условиях России. И связано это Но с тем, что даже крупные ИТ-компании вынуждены писать документацию или согласно ГОСТ или валидируя в ФСТЭК.
А такой подход не предполагает использование подхода к документации как к сервису или коду ,а значит от технического писателя требуются уже другие компетенции, и ему совершенно не нужно уметь в докер; зато вот знать ФТБ или РВ более полезно.
Что же касается доли именно госдокументации - она огромна. Яндекс, Маил, Касперский - все пишут доки именно такого плана. Что же говорить о компаниях поменьше.
Зачем компании техпис, который может в docasacode, когда его Изделия надо офрмлять согласно РВ.
))
а что сложного в ГОСТе? я пишу по ГОСТу относительно легко
но мне всегда нравилось переключаться со стиля на стиль
источник

FM

Fox Mulder in DocOps-сообщество
Andrei Yemelianov
я тоже
что такое синопсис применительно к техдокументации?
Я имел ввиду - мироощущение, миросозерцание. То есть то, как мы воспринимаем окружаещее нас и следовательно, путём трансформации в нашем сознании, формируем действие.
источник

AY

Andrei Yemelianov in DocOps-сообщество
я писал и речь для полпреда президента, и статью для исламской газеты (сам при этом не будучи мусульманином), и околомузыкальную публицистику - и мне нравилось переключаться и соответствовать клише
источник

VI

Vladimir Izmalkov in DocOps-сообщество
Не согласен.
источник

VI

Vladimir Izmalkov in DocOps-сообщество
А еще это коротко и по делу.
Напомниаю - к.т.н.,
8 лет в НИИ,
должности от МНС до начальника Научно-исследовательского отдела.
Таким образом - я ходячий контр-аргумент =).
источник

АВ

Александр Викторович in DocOps-сообщество
щас бы устраивать споры, а потом удалять сообщения - сиди угадывай аргументы оппонента
источник

NV

Nick Volynkin in DocOps-сообщество
Коллеги, а кто-нибудь работал в Jekyll с локализацией? А занимались ли оптимизацией сборки?
источник
2019 October 17

НН

Нац Нац in DocOps-сообщество
источник

MP

Michael Pak in DocOps-сообщество
Коллеги, доброе утро. Кто-нибудь юзал gollum (https://github.com/gollum/gollum)? Поделитесь опытом, пожалуйста.
источник

NV

Nick Volynkin in DocOps-сообщество
Моя прелесть! Интересный инструмент, не использовал пока, но стоит попробовать.
источник

VS

Vadim Smelyanskiy in DocOps-сообщество
Всегда хотел иметь интегрированную среду под DocOps процесс, но только ради одной фичи: комментарии к версии документа от внешних участников.

Внутри команды, ок, есть merge request'ы в GitLab'е. Но не буду же я каждого мимолётного клиента погружать в свой причудливый тулсет?

У кого-нибудь есть решения, кроме ручной сверки комментариев из .docx/Google Docs с исходником в репозитории?
источник

NV

Nick Volynkin in DocOps-сообщество
Vadim Smelyanskiy
Всегда хотел иметь интегрированную среду под DocOps процесс, но только ради одной фичи: комментарии к версии документа от внешних участников.

Внутри команды, ок, есть merge request'ы в GitLab'е. Но не буду же я каждого мимолётного клиента погружать в свой причудливый тулсет?

У кого-нибудь есть решения, кроме ручной сверки комментариев из .docx/Google Docs с исходником в репозитории?
А вроде есть тулзы для прикручивания комментариев к любой веб-странице с текстом. Что-то я встречал, поищу.
источник

NV

Nick Volynkin in DocOps-сообщество
Именно комментариев к любой строке, как в гуглдокс. Не под документом.
источник

VS

Vadim Smelyanskiy in DocOps-сообщество
Nick Volynkin
А вроде есть тулзы для прикручивания комментариев к любой веб-странице с текстом. Что-то я встречал, поищу.
Такие есть, да

О чём именно я мечтаю, так это об ассоциации этих строк комментариев со строчками в исходниках (.md, .rst и т.д.)
источник

VS

Vadim Smelyanskiy in DocOps-сообщество
Это несложно, можно метаданных в сгенерированный сайт напихать

Но я всё надеюсь, что мне не нужно будет это кодить 🙃
источник