Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Из чего же сделаны наши стайлгайды? (Семён Факторович)

Из чего же сделаны наши стайлгайды? (Семён Факторович)

http://docfactor.ru
http://documentat.io

DocFactor'17, конференция о технической документации. 26 ноября 2017, Новосибирск, НГУ.

Из чего же сделаны наши стайлгайды? Семён Факторович, НГУ, documentat.io

Видео: https://www.youtube.com/watch?v=HzLWm2hhy3k

У программистов есть coding guidelines, у журналистов — редакционные политики, а что же есть у технических писателей? Правильно, внутренние гиды по стилю. Мы поговорим о том, какие задачи решает внутренний гид по стилю, почему он полезен не только документационной команде, с чего начать его создание и из каких кирпичиков его собирать.

More Decks by DocFactor: конференция о технической документации

Other Decks in Education

Transcript

  1. • Семён Факторович • Руководитель отдела технической документации, Zodiac Novosibirsk

    • Старший преподаватель НГУ • Независимый консультант по вопросам документирования Кто здесь?
  2. • Правила оформления • Локальные соглашения • Паттерны и антипаттерны

    Внутренний гид по стилю для документации +фундаментальные источники истины
  3. • Справочник по правописанию и стилистике Розенталя • Орфографический словарь

    на ваш вкус (gramota.ru) Фундаментальные источники истины
  4. • Фундаментальные источники истины • Повторение важных пунктов из ФИИ

    • Опровержения ФИИ • Локальные соглашения (включая глоссарий) Внутренний гид по стилю для документации
  5. • «Где фундаментальные источники истины?» • «Твой текст нарушает пункт

    14 нашего стайлгайда!» • Правила для автоматизированной проверки Гид по стилю: сценарии использования
  6. • Microsoft Manual of Style • IEEE Editorial Style Manual

    • The Chicago Manual of Style • rdpk.ru Что почитать?