Size: a a a

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

2021 December 19

K

K in Технические писатели
Видимо мой навык структурирования написанного был плохо развит (на русском тоже плохо писал), поэтому были сложности. Ну и переосмыслил что такое синтаксис и зачем он нужен. Теперь не испытываю сложностей в письме на англ, вслед за этим и письмо на русском подтянулось.
источник

K

K in Технические писатели
Для меня написание эссе очень помогло. До этого только кривые сочинения в школе писал, на тот момент меня риторика не интересовала. А сейчас я большой фанат creative writing.
источник

ET

Eduard Tibet in Технические писатели
Не только ссылаться. Но и "собирать" (от слов fetch, gather) единые по смыслу (семантике) компоненты текста. Допустим, как я уже говорил, так работает автоматическая проверка полноты описания компонентов в user manual. Т.е. автоматически собираются все guiitem и потом сравнивается с существующим списком. Если чего-то нет - присылается письмо или CI/CD сваливается со статусом failed. Но опять же, это имеет смысл в больших (даже огромных)  массивах текстов по схожей тематике. Т.е. это уровень корпорацией, а не небольших компаний. P.S. Кстати, многие компании поменьше, у которых был DocBook и которые захотели перейти от редактирования в XML редакторе к редактированию "в чем угодно" перешли именно на adoc, а не markdown. Например, компания Neo Technology (разработчик Neo4j).
ИМХО (чисто ИМХО) маркдаун - это баловство :)
источник

NS

Nikolai Sobinov in Технические писатели
Если вы есть в VK, найдите там группу Irina Lutsenko. Вам, скорее всего, будет интересно. :)
источник

K

K in Технические писатели
Не пользуюсь контактом, но, возможно, как нибудь доберусь. Спасибо! :)
источник

rK

rJIynbIu` KOT in Технические писатели
https://cloud.google.com/docs и https://cloud.yandex.ru/docs на маркдауне, не на чистом, а на GFM и YFM соответственно, чуть подкрутили обычный маркдаун и закрыли все потребности
источник

ET

Eduard Tibet in Технические писатели
А там особо никаких потребностей то и нет :)
источник

rK

rJIynbIu` KOT in Технические писатели
ну не скажи, отличия от чистого маркдауна значительные
источник

ET

Eduard Tibet in Технические писатели
Все равно это все баловство - семантики то нет :)
источник

rK

rJIynbIu` KOT in Технические писатели
а это что такое? я не особо вчитывался выше, можно тыкнуть в обьяснение
источник

SR

Stas Rychkov in Технические писатели
Тогда это будет новый язык. Нет?
источник

SR

Stas Rychkov in Технические писатели
То есть вы имеете в виду, что здесь, в MD по сравнению языками XML-driven, есть уязвимость в виде невозможности машинного извлечения сути без глубокого изучения? Верно понял?
источник

SR

Stas Rychkov in Технические писатели
Привет всем. Отличная статья про REST. Думаю понравится и тем, кто создаёт API, и тем, кто никогда не curl'ил.

https://oleb.net/2018/rest/
источник
2021 December 20

АП

Александр Парень... in Технические писатели
curl наше всё )
источник

ET

Eduard Tibet in Технические писатели
См. выше по тредику.
источник

ET

Eduard Tibet in Технические писатели
Да. Но все не ограничивается только XML-based markups. Семантика же не только XML-based (rst, adoc - тоже семантика, но они lightweight ML).
источник

А

Александра in Технические писатели
Добрый день!

Моя команда разрабатывает программно-математической обеспечение системы технического зрения, а я пишу документацию по ЕСПД. Пишу впервые:) Добралась до спецификации и возник вопрос.

По ГОСТ 19.202-78:
5. В раздел "Документация" вносят программные документы на данную программу, кроме спецификации и технического задания, в порядке возрастания кода вида документа, входящего в обозначение.

Далее записывают заимствованные программные документы. Запись их производится в порядке возрастания кодов организаций (предприятий)-разработчиков и далее в порядке возрастания кода вида документа, входящего в обозначение.

Из
заимствованные программные документы. Запись их производится в порядке возрастания кодов организаций (предприятий)-разработчиков и далее в порядке возрастания кода вида документа, входящего в обозначение.

Из заимствованного пользуются библиотекой функций ZMQ, Фреймворки и библиотеки для python с открытым исходным кодом. Каким образом заполнить графу "обозначение" документа. Вписать лицензию на эти фреймворки? Но меня смущает фраза ... в порядке возрастания кода вида документа. Там ведь нет той программной документации, которая определена ЕСПД. Может, такие вещи вообще вносить не нужно?
источник

АД

Анастасия Дахина... in Технические писатели
Такие вещи вносить не нужно. Когда речь идет о заимствованных вещах это проекты госсектора с соответствующими децимальными номерами.
источник

А

Александра in Технические писатели
Спасибо!
источник

А

Александра in Технические писатели
Лист утверждения для документа, имеющего несколько частей, один?

Например, у программы и методик испытания 4 части (ПИ. ПСИ, ЛОИ, КДИ). Лист утверждения для них всех один или 4 для каждой части?
источник