Size: a a a

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

2020 February 11

NV

Nick Volynkin in DocOps-сообщество
Elena Parameshwari L24[Mg7]
Ребята и девчата, привет! Хочется с вами посоветоваться. У нас разработчики ведут новый проект, и встроенную документацию (ака описание встроенного языка) решили "писать сами". Сейчас они хранят это дело, как мне показали, в Confluence, в виде каталогов и файлов формата md. А меня на днях "попросили вычитать". Но меня волнует такой аспект: предполагается работа с этими markdown-файлами "просто через git", и есть подозрение, что если оставить все в текущей организации, с развитием этого встроенного языка, я рискую потерять "контроль" над тем, что происходит. Хотелось бы спросить у тех, кто работает с mardown, как вы организуете хранение файлов, как можно, например, "хотя бы оценить объем текста", как отслеживаете изменения этого текста (например, если документы и их изменения для следующих версий планируется отдавать на перевод)? Пока мне не кажется управляемой куча папок и файлов, которую мне хотят "просто выгрузить из confluence". И это немного напрягает...
Ох, это ответ на полчаса )
источник

NV

Nick Volynkin in DocOps-сообщество
постараюсь вечером написать подробнее
источник

NV

Nick Volynkin in DocOps-сообщество
Пока что могу предложить свой старый доклад на SECR. Там я рассказывал в целом о преимуществах подхода «документация как код», в том числе было про хранение файлов, ревью, переводы и публикацию. https://youtu.be/sVStWzgDnNA
источник

EP

Elena Parameshwari L24[Mg7] in DocOps-сообщество
Спасибо большое!
источник

RG

Ramil G in DocOps-сообщество
Nick Volynkin
Пока что могу предложить свой старый доклад на SECR. Там я рассказывал в целом о преимуществах подхода «документация как код», в том числе было про хранение файлов, ревью, переводы и публикацию. https://youtu.be/sVStWzgDnNA
Отличный доклад. Спасибо
источник

NK

ID:0 in DocOps-сообщество
Конспект доклада Универсальная карта компетенций с TeamLeadConf 2020

Я сегодня на конференции для тимлидов и здесь тема управления знаниями актуальна, как никогда. Начинаем день с доклада Галины Головановой из Тинькофф, она рассказала, как они применили у себя популярную методику построения карты компетенций в команде.

Ссылка на конспект: https://github.com/lananovikova10/conspectus/blob/master/competence-matrix-tinkoff.md
источник

NV

Nick Volynkin in DocOps-сообщество
источник

ML

Maksim Lapshin in DocOps-сообщество
Класс
источник

NV

Nick Volynkin in DocOps-сообщество
Elena Parameshwari L24[Mg7]
Ребята и девчата, привет! Хочется с вами посоветоваться. У нас разработчики ведут новый проект, и встроенную документацию (ака описание встроенного языка) решили "писать сами". Сейчас они хранят это дело, как мне показали, в Confluence, в виде каталогов и файлов формата md. А меня на днях "попросили вычитать". Но меня волнует такой аспект: предполагается работа с этими markdown-файлами "просто через git", и есть подозрение, что если оставить все в текущей организации, с развитием этого встроенного языка, я рискую потерять "контроль" над тем, что происходит. Хотелось бы спросить у тех, кто работает с mardown, как вы организуете хранение файлов, как можно, например, "хотя бы оценить объем текста", как отслеживаете изменения этого текста (например, если документы и их изменения для следующих версий планируется отдавать на перевод)? Пока мне не кажется управляемой куча папок и файлов, которую мне хотят "просто выгрузить из confluence". И это немного напрягает...
А они точно в Confluence хранят файлы формата MD? Прямо файлы туда загружены?
источник

EP

Elena Parameshwari L24[Mg7] in DocOps-сообщество
Nick Volynkin
А они точно в Confluence хранят файлы формата MD? Прямо файлы туда загружены?
Пока да. Они мне это вчера и показали.
источник

NK

ID:0 in DocOps-сообщество
Полиция знаний продолжает работу! Сегодня в 16:30 по Мск будет конкурс-голосование за самое страшное преступление против знаний. Ссылку или опрос скину сюда.
источник

NK

ID:0 in DocOps-сообщество
​​Сообщество Write the Docs тоже работает на своём стенде на TeamLeadConf. Только что Семён Факторович и Константин Валеев провели митап «Что делать, чтобы документация не болела». Держите конспект: docops-hq.github.io/conf/teamleadconf/20/documentation_challenges/
источник

TZ

Timofey Zakrevskiy in DocOps-сообщество
А где ответ на пункт 7?=)
источник

NV

Nick Volynkin in DocOps-сообщество
Timofey Zakrevskiy
А где ответ на пункт 7?=)
@kvaleev @factorized и правда, где?
источник

DS

Daria Savina in DocOps-сообщество
Нет на него ответа, увы. Это не вопрос, а констатация )
источник

NV

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

K

Konstantin in DocOps-сообщество
Nick Volynkin
@kvaleev @factorized и правда, где?
С нумерацией не сложилось :) Пункт 3 — это, на самом деле, пункты 3–4, а дальше смещение на 1
источник

VI

Vladimir Izmalkov in DocOps-сообщество
вопрос 5 - её никто не читает - ответ см. п.0 Выделить роль. То есть надо назначить того, кто будет читать документацию? Технического читателя?
источник

K

Konstantin in DocOps-сообщество
Konstantin
С нумерацией не сложилось :) Пункт 3 — это, на самом деле, пункты 3–4, а дальше смещение на 1
Кинем пулл-реквест
источник

VI

Vladimir Izmalkov in DocOps-сообщество
Konstantin
С нумерацией не сложилось :) Пункт 3 — это, на самом деле, пункты 3–4, а дальше смещение на 1
да, теперь понятнее
источник