Size: a a a

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

2020 March 25

AK

Alexander Kosarau in DocOps-сообщество
Скайпом
источник

AK

Alexander Kosarau in DocOps-сообщество
простите)
источник

KC

Kseniya Chudakova in DocOps-сообщество
Alexander Kosarau
Скайпом
Not bad
источник

H

Hartmann in DocOps-сообщество
Alexander Kosarau
Скайпом
Хах. Хорош.
источник

KC

Kseniya Chudakova in DocOps-сообщество
Только не говорите, что надо уйти с винды. На это есть причины)
источник

АП

Андрей Привалов in DocOps-сообщество
cmder пользовался, когда на винде жил
источник

RG

Ramil G in DocOps-сообщество
Kseniya Chudakova
Привет всем! Каким терминалом пользуетесь под виндой (кроме bash и powershell) ?
источник

NP

Nikolaj Potashnikov in DocOps-сообщество
Vadim Smelyanskiy
Аргумент про семантическую разметку мне близок, но я лично не видел хорошей разметки и на базе предлагаемого RST

Кто-нибудь может поделиться опытом, кто прям размечает в доке данные (например, определения) и с этой разметкой что-то делает?
Прошу прощения, telegram не к тому посту ответ прикрепил. Достаточно много. Но обычно наоборот, есть внешняя семантика, которую мы применяем при формировании документа (и других артефактов). Например, термины могут храниться в csv-файлах, а при сборке документа вставляться в нужные места документов, картинок (и даже интерфейса).
источник

VS

Vadim Smelyanskiy in DocOps-сообщество
Nikolaj Potashnikov
Прошу прощения, telegram не к тому посту ответ прикрепил. Достаточно много. Но обычно наоборот, есть внешняя семантика, которую мы применяем при формировании документа (и других артефактов). Например, термины могут храниться в csv-файлах, а при сборке документа вставляться в нужные места документов, картинок (и даже интерфейса).
Внешняя семантика – понятный путь, да

Одно беспокоит: неудобно, когда пишешь документ, и для добавления нового термина нужно отвлечься на базу терминов

Вы как-то с этим боретесь?
источник

NP

Nikolaj Potashnikov in DocOps-сообщество
Hartmann
Но он ведь не интерактивный.
А если в нём изображения есть. Как мне рассмотреть их в оригинальном разрешении? Это не веб, кликнуть и увидеть превью не выйдет.
Тут Вы начинаете относиться к ворду, как к исходнику. Если нужно РАССМОТРЕТЬ картинку, то pdf ее не портит. А если нужно РАССМОТРЕТЬ В ОРИГИНАЛЬНОМ РАЗРЕШЕНИИ, то это не выглядит как цель документации. И, кроме того, ожидать от читателя документации, что он переименует word в zip, разархивирует его и залезет в папку media...)) Word можно использовать в качестве выходного формата, но он крайне опасен.  Его тут же начинают использовать как исходник и ломают всю документацию.
источник

NP

Nikolaj Potashnikov in DocOps-сообщество
Vadim Smelyanskiy
Внешняя семантика – понятный путь, да

Одно беспокоит: неудобно, когда пишешь документ, и для добавления нового термина нужно отвлечься на базу терминов

Вы как-то с этим боретесь?
Тут серебряной пули нет. Одно ясно, если есть внешняя семантика, то лучше лишний раз отвлечься, чем потом шерстить весь текст (ночью, перед сдачей документации). В целом, рецепты, видимо, такие: давать логичные и краткие названия семантическим элементам (их часто просто запоминаешь в какой-то момент), как это ни странно — транслит (не придумывать английские имена оригинальным русским терминам, русские проще запомнить), vim или Emacs (чтобы быстро работать с различными исходниками).
источник

VS

Vadim Smelyanskiy in DocOps-сообщество
Nikolaj Potashnikov
Тут Вы начинаете относиться к ворду, как к исходнику. Если нужно РАССМОТРЕТЬ картинку, то pdf ее не портит. А если нужно РАССМОТРЕТЬ В ОРИГИНАЛЬНОМ РАЗРЕШЕНИИ, то это не выглядит как цель документации. И, кроме того, ожидать от читателя документации, что он переименует word в zip, разархивирует его и залезет в папку media...)) Word можно использовать в качестве выходного формата, но он крайне опасен.  Его тут же начинают использовать как исходник и ломают всю документацию.
Тогда есть HTML

Сгенерированный сайт сложно "сломать" в этом понимании, но он может быть интерактивным
источник

VS

Vadim Smelyanskiy in DocOps-сообщество
Но его не все принимают :(
источник

VS

Vadim Smelyanskiy in DocOps-сообщество
Nikolaj Potashnikov
Тут серебряной пули нет. Одно ясно, если есть внешняя семантика, то лучше лишний раз отвлечься, чем потом шерстить весь текст (ночью, перед сдачей документации). В целом, рецепты, видимо, такие: давать логичные и краткие названия семантическим элементам (их часто просто запоминаешь в какой-то момент), как это ни странно — транслит (не придумывать английские имена оригинальным русским терминам, русские проще запомнить), vim или Emacs (чтобы быстро работать с различными исходниками).
Про логичные и краткие названия в семантике

Любимый, пусть и не самый хороший пример: кодификация правил Википедии
источник

H

Hartmann in DocOps-сообщество
Nikolaj Potashnikov
Тут Вы начинаете относиться к ворду, как к исходнику. Если нужно РАССМОТРЕТЬ картинку, то pdf ее не портит. А если нужно РАССМОТРЕТЬ В ОРИГИНАЛЬНОМ РАЗРЕШЕНИИ, то это не выглядит как цель документации. И, кроме того, ожидать от читателя документации, что он переименует word в zip, разархивирует его и залезет в папку media...)) Word можно использовать в качестве выходного формата, но он крайне опасен.  Его тут же начинают использовать как исходник и ломают всю документацию.
Мы сейчас можем далеко уйти в этой теме, но у меня таки есть Вам сказать пару слов. Дальше будет немножечко сарказма. :)

Постараюсь, кратко и тезисно поделиться своими наблюдениями. Говорим в контексте вэба и современных инструментов, тенденций, методик и подходов (на категоричную истину в последней инстанции не претендую):

— целевая аудитория влияет => большинство пользователей (а сегодня — это вэб) хочет документацию, чтоб просто, красиво, понятно, ну и быстро находить нужное.  
Посмотрите на документацию Sketch, Apple, Slack и всё сразу встанет на свои места. Подход виден сразу: авторы уважают пользователей и проявляют заботу. Почему? Потому что надо делать хорошо, ну и потому что деньги. ;)

— ворд — ад.
Он не интерактивен, неудобен, как в качестве инструмента, так и конечного формата.
Я, как и большинство пользователей, ни за что бы не стал читать документацию в ворде (ну если только за деньги :) ) и иметь дело с компанией, которая вот так относится к своим пользователям.

— всякие HATs— тот же ад, что и ворд, только по $2к за одну лиц. копию. Больше ничего не скажу, не хочу никого обидеть. :)
Исключение: писанина всяких мануалов в сугубо спец. среде и на производстве.

— ПэДэФэ — кромешный ад.
Неискушённые пользователи не станут это читать. «Потому что «фу» (и да, это таки цитата :) ).

Последние 5 лет пишу доки для вэба (документация для различных продуктов/услуг, так же документировал WP темы/шаблоны для продажи на ThemeForest), в том числе и на фрилансе.

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

Вывод: будущее за интерактивом, вэбом, мд, ссг’эшками; будущее за документацией здесь и сейчас, вспоминаем (Николай ещё здесь писал о доке по синтаксису Раста) Elm и Rust.

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

Ну и, я не могу не упомянуть о Томе Джонсоне, у него масса отличных материалов на поднятые выше темы. Ознакомиться можно на
https://idratherbewriting.com

Ворд, HATs, ПэДэФэ и еже с ними — рудименты, которые нужно оставить в 90-ых, забыть, запить и забить. ;)

Теперь можете бить меня палками, бросаться камнями, банить и вот это вот всё.
Сэ — Сарказм.
источник

СФ

Семён Факторович in DocOps-сообщество
Hartmann
Мы сейчас можем далеко уйти в этой теме, но у меня таки есть Вам сказать пару слов. Дальше будет немножечко сарказма. :)

Постараюсь, кратко и тезисно поделиться своими наблюдениями. Говорим в контексте вэба и современных инструментов, тенденций, методик и подходов (на категоричную истину в последней инстанции не претендую):

— целевая аудитория влияет => большинство пользователей (а сегодня — это вэб) хочет документацию, чтоб просто, красиво, понятно, ну и быстро находить нужное.  
Посмотрите на документацию Sketch, Apple, Slack и всё сразу встанет на свои места. Подход виден сразу: авторы уважают пользователей и проявляют заботу. Почему? Потому что надо делать хорошо, ну и потому что деньги. ;)

— ворд — ад.
Он не интерактивен, неудобен, как в качестве инструмента, так и конечного формата.
Я, как и большинство пользователей, ни за что бы не стал читать документацию в ворде (ну если только за деньги :) ) и иметь дело с компанией, которая вот так относится к своим пользователям.

— всякие HATs— тот же ад, что и ворд, только по $2к за одну лиц. копию. Больше ничего не скажу, не хочу никого обидеть. :)
Исключение: писанина всяких мануалов в сугубо спец. среде и на производстве.

— ПэДэФэ — кромешный ад.
Неискушённые пользователи не станут это читать. «Потому что «фу» (и да, это таки цитата :) ).

Последние 5 лет пишу доки для вэба (документация для различных продуктов/услуг, так же документировал WP темы/шаблоны для продажи на ThemeForest), в том числе и на фрилансе.

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

Вывод: будущее за интерактивом, вэбом, мд, ссг’эшками; будущее за документацией здесь и сейчас, вспоминаем (Николай ещё здесь писал о доке по синтаксису Раста) Elm и Rust.

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

Ну и, я не могу не упомянуть о Томе Джонсоне, у него масса отличных материалов на поднятые выше темы. Ознакомиться можно на
https://idratherbewriting.com

Ворд, HATs, ПэДэФэ и еже с ними — рудименты, которые нужно оставить в 90-ых, забыть, запить и забить. ;)

Теперь можете бить меня палками, бросаться камнями, банить и вот это вот всё.
Сэ — Сарказм.
- есть немало индустрий, в которых docx — обязательное требование (в силу регуляторных или законодательных правил, например)
- есть немало бизнесов, в которых однофайловая, доступная офлайн дока (т.е. docx  или pdf) — обязательное требование. Тендеры, конкурсы, своеобразые процессы продаж и пресейла, и пр. HTML тут никак не подойдет
источник

H

Hartmann in DocOps-сообщество
Семён Факторович
- есть немало индустрий, в которых docx — обязательное требование (в силу регуляторных или законодательных правил, например)
- есть немало бизнесов, в которых однофайловая, доступная офлайн дока (т.е. docx  или pdf) — обязательное требование. Тендеры, конкурсы, своеобразые процессы продаж и пресейла, и пр. HTML тут никак не подойдет
Безусловно.
источник

СФ

Семён Факторович in DocOps-сообщество
наш опыт говорит, что немалое количество заказчиков хочет сразу и единый DOCX, и многостраничный HTML-портал с идентичным контентом
источник

СФ

Семён Факторович in DocOps-сообщество
> Ворд, HATs, ПэДэФэ и еже с ними — рудименты, которые нужно оставить в 90-ых, забыть, запить и забить. ;)

Не везде, увы. Будущее, о котором вы говорите, пока еще неравномерно распределено:)
источник

H

Hartmann in DocOps-сообщество
Только хотел написать, что наравне с пдф и тд, нужно держать всё в онлайне.
источник