Size: a a a

technicalwriters

2020 November 02

IA

Ivan Abashkin in technicalwriters
Fagor
А чем md хуже asciidoc?

База разметки есть и в md, + двиг типа грав на сервере, и yaml можно вообще свои теги для разметки создать, если php не пугает.

Спрашиваю почему - asciidoc не знаю, но на первый взгляд как то он "устарел", ну т.е. не дружит с модными новыми технологиями, а то что там больше всего, зачем мне, если я с пол щелчка его не смогу заводить на другом софте (представлении, парсинг в базу к примеру, без регулярок сложных)
Ну одно другому не мешает. С помощью пандока можно сконвертировать в случае необходимости.
Мне кажется, что тут выбирать язык разметки нужно исходя и своих задач.

Например, внешнюю базу знаний мы будем вести в .md

В пользовательской документации для нас был важен именно вопрос богатства возможностей разметки. Одной из ключевых особенностей повлиявших на выбор аскидока была нормальная работа с таблицами.
источник

ET

Eduard Tibet in technicalwriters
Fagor
А чем md хуже asciidoc?

База разметки есть и в md, + двиг типа грав на сервере, и yaml можно вообще свои теги для разметки создать, если php не пугает.

Спрашиваю почему - asciidoc не знаю, но на первый взгляд как то он "устарел", ну т.е. не дружит с модными новыми технологиями, а то что там больше всего, зачем мне, если я с пол щелчка его не смогу заводить на другом софте (представлении, парсинг в базу к примеру, без регулярок сложных)
А, это все же был вопрос. Отвечу на него. Маркдаун не содержит т.н. семантики и не позволяет оперировать с частями документа, как с блоками. Изначально asciidoc создавался, как plain-текстовая альтернатива DocBook и полностью эквивалентен ему по синтаксису семантической разметки. Здесь важно именно такая штука, как семантическая разметка.
источник

F

Fagor in technicalwriters
Eduard Tibet
Это к чему вопрос был? Или это как рассуждение?
Это вопрос понять, стоит присмотреться к ансидок, или не стоит, и в принципе md достаточен. Я тут вообще думаю как ide какую накрутить на работу с доками, а не файлами кода
источник

F

Fagor in technicalwriters
Eduard Tibet
А, это все же был вопрос. Отвечу на него. Маркдаун не содержит т.н. семантики и не позволяет оперировать с частями документа, как с блоками. Изначально asciidoc создавался, как plain-текстовая альтернатива DocBook и полностью эквивалентен ему по синтаксису семантической разметки. Здесь важно именно такая штука, как семантическая разметка.
спасибо.
источник
2020 November 03

KU

Kateryna Ushakova in technicalwriters
Накидайте, пожалуйста, аргументов по поводу буквы ё в разных видах документации. Нужна ли? Почему создаёт проблемы?
источник

ДБ

Данил Боровков... in technicalwriters
Kateryna Ushakova
Накидайте, пожалуйста, аргументов по поводу буквы ё в разных видах документации. Нужна ли? Почему создаёт проблемы?
На счет применимости в разных видах документации не скажу. Мое мнение — нужно использовать ее либо во всех документах, либо нигде. Чтобы все знали как писать. Бывает так, что когда над документом трудится несколько человек с разным мировоззрением, то при прочтении бросается в глаза либо отсутствие ё, либо её наличие.
Проблемы:
- нужно проверять текст (если ё используется) после каждой итерации
- нужно знать когда писать (разработчики иногда не то что ё не используют, а допускают простые ошибки)
Конечно, текст с ё выглядит более осознанным, но так должны уметь писать все. Поэтому корпоративный регламент must have
источник

IC

Ivan Cheban in technicalwriters
😂
источник

IC

Ivan Cheban in technicalwriters
источник

Ю

Юлия in technicalwriters
Вега
Добрый день, коллеги! А как грамотно указать в ТЗ на доработку, что после проведения тестирования ПО уже на этапе приемки, можно было вернуться к вендору и ещё что-нибудь добавить/убрать ?
если потерпит, в среду могу кинуть пару рабочих шаблонов, напомните только :)
источник

В

Вега in technicalwriters
Юлия
если потерпит, в среду могу кинуть пару рабочих шаблонов, напомните только :)
Было бы просто чудесно 🥰
Спасибо!
источник

L

Lex in technicalwriters
Буква "Ё" не нужна, говорили они ©
источник

Ю

Юлия in technicalwriters
у меня встречный вопрос: есть на аутсорсе исполнитель, проектирование систем в госсекторе. я со стороны госсектора, собственно, слежу за документацией.
на аутсорсе со стороны техписателей авторы в руководстве пользователя постоянно вставляют 📋 иконки посреди текста ✍️ из системы, чтобы показать кнопки.
так как этот документ потом сшивается в том по проекту, каждый раз мы с ней грыземся по поводу гостовского оформления.
я намекала на требования ЕСПД к печатным документам, но она настаивает на том, что требования к руководству оператора ей не запрещают.
может в чате кто-то может подсказать, чем можно оперировать? или переходить к физическому воздействию?..
источник

SR

Stas Rychkov in technicalwriters
Kateryna Ushakova
Накидайте, пожалуйста, аргументов по поводу буквы ё в разных видах документации. Нужна ли? Почему создаёт проблемы?
Потому что не создаёт. Но чу! Вторник. Передохнём.
источник

L

Luiza in technicalwriters
Юлия
у меня встречный вопрос: есть на аутсорсе исполнитель, проектирование систем в госсекторе. я со стороны госсектора, собственно, слежу за документацией.
на аутсорсе со стороны техписателей авторы в руководстве пользователя постоянно вставляют 📋 иконки посреди текста ✍️ из системы, чтобы показать кнопки.
так как этот документ потом сшивается в том по проекту, каждый раз мы с ней грыземся по поводу гостовского оформления.
я намекала на требования ЕСПД к печатным документам, но она настаивает на том, что требования к руководству оператора ей не запрещают.
может в чате кто-то может подсказать, чем можно оперировать? или переходить к физическому воздействию?..
А где в ЕСПД запрет на иконки в тексте? Почему нет? Особенно пиктограммы всякие
источник

OT

Olga T. in technicalwriters
Коллеги, кто-нибудь использует Confluence в качестве Web-CMS или экспортирует html из Confluence в Web-CMS? У нас интранет на базе Confluence, техническую документацию пишем в SCHEMA ST4 и ворде, печатный каталог верстаем в InDesign, контент на сайте публикуем в webEdition (собираемся переходить на другую CMS), в начале года внедрили Vault в качестве PDM, а в качестве ERP у нас ProALPHA. Хотим создать единую центральную базу данных, из которой можно было бы по принципу единого источника публиковать контент на сайте и экспортировать PDF для каталога. Желательно на базе одной из имеющихся систем. Если кто-нибудь использует для этого Confluence, поделитесь, пожалуйста, ссылкой, как выглядит результат.
источник

ET

Eduard Tibet in technicalwriters
Olga T.
Коллеги, кто-нибудь использует Confluence в качестве Web-CMS или экспортирует html из Confluence в Web-CMS? У нас интранет на базе Confluence, техническую документацию пишем в SCHEMA ST4 и ворде, печатный каталог верстаем в InDesign, контент на сайте публикуем в webEdition (собираемся переходить на другую CMS), в начале года внедрили Vault в качестве PDM, а в качестве ERP у нас ProALPHA. Хотим создать единую центральную базу данных, из которой можно было бы по принципу единого источника публиковать контент на сайте и экспортировать PDF для каталога. Желательно на базе одной из имеющихся систем. Если кто-нибудь использует для этого Confluence, поделитесь, пожалуйста, ссылкой, как выглядит результат.
Если вам печатные каталоги (хорошие с полиграфическим качеством, CMYK и т.п.), то конфлуенс вам точно не подойдет. Для печатки вам нужен что-то из XML based markups + хороший print/FO engine типа Antenna House. Или как вариант делать импорт xml контента внутрь Indesign, используя нативные возможности indesign. См. небольшую книгу Oreiily: XML Publishing with Adobe InDesign В этом случае вам НЕ нужен FO engine.
источник

OT

Olga T. in technicalwriters
Eduard Tibet
Если вам печатные каталоги (хорошие с полиграфическим качеством, CMYK и т.п.), то конфлуенс вам точно не подойдет. Для печатки вам нужен что-то из XML based markups + хороший print/FO engine типа Antenna House. Или как вариант делать импорт xml контента внутрь Indesign, используя нативные возможности indesign. См. небольшую книгу Oreiily: XML Publishing with Adobe InDesign В этом случае вам НЕ нужен FO engine.
Принт для нас вторичен, сначала хотелось бы выяснить, подойдёт ли Confluence в качестве базы данных для сайта (переиспользование контента из Confluence на сайте). Пока вот что нагуглила: https://www.addteq.com/blog/2017/07/3-ways-of-turning-confluence-into-your-website-s-cms
источник
2020 November 04

ДЧ

Дарья Чернавина... in technicalwriters
Lex
Буква "Ё" не нужна, говорили они ©
А что, мне нравится эта мысль без «ё» 😀
источник

F

Fagor in technicalwriters
Olga T.
Принт для нас вторичен, сначала хотелось бы выяснить, подойдёт ли Confluence в качестве базы данных для сайта (переиспользование контента из Confluence на сайте). Пока вот что нагуглила: https://www.addteq.com/blog/2017/07/3-ways-of-turning-confluence-into-your-website-s-cms
Я думаю нет, так как он не для этого. Но натянуть, при желании всегда можно. Проблем особых не вижу. Изначально будет криверько, потом можно будет ставить на поток.
источник

АA

Александра Aнащенко... in technicalwriters
Привет. Работаю техписателем в частной около-оборонке (ОКРы, спецсредства, госконтракты, вот это всё). На днях предложили левую подработку — подготовить комплект документации на продукт по ЕСКД + минимально оформить ПО по ЕСПД. С одной стороны, технически тема прям моя, и даже требования нужного ведомства знакомы.
С другой, возникла куча наивных вопросов, начиная с того, законна ли такая подработка)) Я работала только глубоко в организации, где более-менее налажены процессы и укомплектован штат документаторов, поэтому орг.вопросы прошли мимо, эта часть мозга девственно чиста. Что-то нагуглила, но чувствую себя шатко.
Накидаю вопросы, интересен такой опыт и знания:
1. Про законность: есть вероятность, что продукт левой организации тоже является спецсредством (вопрос на рассмотрении). Почитала КонсультантПлюс про особенности оформления допуска к гостайне при работе по совместительству. Не поняла, насколько это применимо ко мне (по основному месту работы трудоустроена на полный день), и какие потенциальные проблемы для меня и исходной организация. Для себя решила, что в случае спецсредства съезжаю с темы. Но всё равно интересно, реальный вариант? Кто-нибудь так делал?
2. Как оптимально оформить взаимодействие и порядок оплаты? Совместительство, договор на выполнение работ, акты о сдаче-приемке выполненных работ, ещё какие-то документы и умные слова?
3. У левой организации нет четырехзначного буквенного кода организации-разработчика по ГОСТ 2.201. В  таком случае ТУ присваивается обозначение по ОКП продукта и ОКПО организации? А с эксплуатационной документацией как?
4. Документы могут быть подписаны в одно лицо за разработчика и нормоконтролера (если есть удостоверение н/к)?
5. Вопрос оплаты. Нашла в файлах этого чата пдфку за авторством Глаголева с описанием стоимости разработки ТД. Не уверена, что разобралась, но грубо прикинула по одному своему небольшому рабочему комплекту (спецификация, ведомость покупных, сборочный, ТУ на 40 страниц, ЭД суммарно страниц на 40 тоже; ТЗ и ПМИ пока опустим). По нормативам времени на этот комплект выходит порядка 300 ч. Из расчета з/п, например, 50 тр в месяц это около 300 р/ч, следовательно 90 тр суммарно за комплект. Адекватный расчёт по сути или не очень? При расчёте стоит ориентироваться на среднюю з/п по региону или на свою з/п (которая, считаем, отображает квалификацию)?
источник