T
Documentation Plan
спасибо за баззворд, почитаю
Size: a a a
2020 January 01
NV
ребят, а подскажите, с чего вообще начать писать документацию? А то всё кажется необъятным, а когда начинаешь описывать какие-то мелкие компоненты, то начинаешь запутываться в деталях :)
Начните с целеполагания: https://t.me/docops/69
AL
Целеполагание это что?
Постановка целей?
Постановка целей?
2020 January 02
T
Начните с целеполагания: https://t.me/docops/69
Вышел в итоге на ютьюб-канал Факторовича, очень интересный цикл лекций "документация в IT-проектах", весьма похоже на то, что мне надо, чтобы въехать в тему.
А цель довольно проста - я админ/девопс, в компании я один, и я хочу хорошо задокументировать результат трудов своих праведных, хотя бы просто чтобы не хранить все в своей голове. Ну и на случай увольнения, конечно (вопросы с предыдущего рабочего места закончились где-то через год после увольнения. Это нехорошо). Я пытался и раньше писать документацию, но как-то бессистемно, и наступал на все наиболее частые грабли: неактуальность, недоступность, малоинформативность.
Надеюсь, что какие-то бест практисес помогут мне привести ситуацию в более-менее нормальное состояние.
А цель довольно проста - я админ/девопс, в компании я один, и я хочу хорошо задокументировать результат трудов своих праведных, хотя бы просто чтобы не хранить все в своей голове. Ну и на случай увольнения, конечно (вопросы с предыдущего рабочего места закончились где-то через год после увольнения. Это нехорошо). Я пытался и раньше писать документацию, но как-то бессистемно, и наступал на все наиболее частые грабли: неактуальность, недоступность, малоинформативность.
Надеюсь, что какие-то бест практисес помогут мне привести ситуацию в более-менее нормальное состояние.
H
Вышел в итоге на ютьюб-канал Факторовича, очень интересный цикл лекций "документация в IT-проектах", весьма похоже на то, что мне надо, чтобы въехать в тему.
А цель довольно проста - я админ/девопс, в компании я один, и я хочу хорошо задокументировать результат трудов своих праведных, хотя бы просто чтобы не хранить все в своей голове. Ну и на случай увольнения, конечно (вопросы с предыдущего рабочего места закончились где-то через год после увольнения. Это нехорошо). Я пытался и раньше писать документацию, но как-то бессистемно, и наступал на все наиболее частые грабли: неактуальность, недоступность, малоинформативность.
Надеюсь, что какие-то бест практисес помогут мне привести ситуацию в более-менее нормальное состояние.
А цель довольно проста - я админ/девопс, в компании я один, и я хочу хорошо задокументировать результат трудов своих праведных, хотя бы просто чтобы не хранить все в своей голове. Ну и на случай увольнения, конечно (вопросы с предыдущего рабочего места закончились где-то через год после увольнения. Это нехорошо). Я пытался и раньше писать документацию, но как-то бессистемно, и наступал на все наиболее частые грабли: неактуальность, недоступность, малоинформативность.
Надеюсь, что какие-то бест практисес помогут мне привести ситуацию в более-менее нормальное состояние.
Дело правильное. Успехов!
T
Спасибо :)
СФ
Вышел в итоге на ютьюб-канал Факторовича, очень интересный цикл лекций "документация в IT-проектах", весьма похоже на то, что мне надо, чтобы въехать в тему.
А цель довольно проста - я админ/девопс, в компании я один, и я хочу хорошо задокументировать результат трудов своих праведных, хотя бы просто чтобы не хранить все в своей голове. Ну и на случай увольнения, конечно (вопросы с предыдущего рабочего места закончились где-то через год после увольнения. Это нехорошо). Я пытался и раньше писать документацию, но как-то бессистемно, и наступал на все наиболее частые грабли: неактуальность, недоступность, малоинформативность.
Надеюсь, что какие-то бест практисес помогут мне привести ситуацию в более-менее нормальное состояние.
А цель довольно проста - я админ/девопс, в компании я один, и я хочу хорошо задокументировать результат трудов своих праведных, хотя бы просто чтобы не хранить все в своей голове. Ну и на случай увольнения, конечно (вопросы с предыдущего рабочего места закончились где-то через год после увольнения. Это нехорошо). Я пытался и раньше писать документацию, но как-то бессистемно, и наступал на все наиболее частые грабли: неактуальность, недоступность, малоинформативность.
Надеюсь, что какие-то бест практисес помогут мне привести ситуацию в более-менее нормальное состояние.
Спасибо за добрые слова! Буду рад, если в двух словах расскажете, чего в этих лекциях не хватает, какие темы не раскрыты
СФ
А то я сейчас в процессе переосмысления этого курса и хочу его с нуля переделать
NV
Вышел в итоге на ютьюб-канал Факторовича, очень интересный цикл лекций "документация в IT-проектах", весьма похоже на то, что мне надо, чтобы въехать в тему.
А цель довольно проста - я админ/девопс, в компании я один, и я хочу хорошо задокументировать результат трудов своих праведных, хотя бы просто чтобы не хранить все в своей голове. Ну и на случай увольнения, конечно (вопросы с предыдущего рабочего места закончились где-то через год после увольнения. Это нехорошо). Я пытался и раньше писать документацию, но как-то бессистемно, и наступал на все наиболее частые грабли: неактуальность, недоступность, малоинформативность.
Надеюсь, что какие-то бест практисес помогут мне привести ситуацию в более-менее нормальное состояние.
А цель довольно проста - я админ/девопс, в компании я один, и я хочу хорошо задокументировать результат трудов своих праведных, хотя бы просто чтобы не хранить все в своей голове. Ну и на случай увольнения, конечно (вопросы с предыдущего рабочего места закончились где-то через год после увольнения. Это нехорошо). Я пытался и раньше писать документацию, но как-то бессистемно, и наступал на все наиболее частые грабли: неактуальность, недоступность, малоинформативность.
Надеюсь, что какие-то бест практисес помогут мне привести ситуацию в более-менее нормальное состояние.
Да вы золотой человек.
NV
Добро пожаловать всем, кто к нам пришёл и ещё придёт )
BG
Вышел в итоге на ютьюб-канал Факторовича, очень интересный цикл лекций "документация в IT-проектах", весьма похоже на то, что мне надо, чтобы въехать в тему.
А цель довольно проста - я админ/девопс, в компании я один, и я хочу хорошо задокументировать результат трудов своих праведных, хотя бы просто чтобы не хранить все в своей голове. Ну и на случай увольнения, конечно (вопросы с предыдущего рабочего места закончились где-то через год после увольнения. Это нехорошо). Я пытался и раньше писать документацию, но как-то бессистемно, и наступал на все наиболее частые грабли: неактуальность, недоступность, малоинформативность.
Надеюсь, что какие-то бест практисес помогут мне привести ситуацию в более-менее нормальное состояние.
А цель довольно проста - я админ/девопс, в компании я один, и я хочу хорошо задокументировать результат трудов своих праведных, хотя бы просто чтобы не хранить все в своей голове. Ну и на случай увольнения, конечно (вопросы с предыдущего рабочего места закончились где-то через год после увольнения. Это нехорошо). Я пытался и раньше писать документацию, но как-то бессистемно, и наступал на все наиболее частые грабли: неактуальность, недоступность, малоинформативность.
Надеюсь, что какие-то бест практисес помогут мне привести ситуацию в более-менее нормальное состояние.
Как жаль, что существование доки и вопросов с прошлой работы обычно не связаны)
BG
Как вы заставляете всех учасников искать хотя бы пытатся искать инфу вначала в доках, а не сразу у людей?)
T
не знаю, но мне кажется, что когда дока будет, то у меня хотя бы будет на что ссылаться :)
а вот когда документации нет, то да, приходится совместно с человеком заниматься индустриальной археологией и объяснять, что и как было сделано и почему именно так было сделано.
а вот когда документации нет, то да, приходится совместно с человеком заниматься индустриальной археологией и объяснять, что и как было сделано и почему именно так было сделано.
PD
Как вы заставляете всех учасников искать хотя бы пытатся искать инфу вначала в доках, а не сразу у людей?)
Надеемся на естественную интраверсию у многих разработчиков. И общую культуру "не отрывай другого от дела без необходимости"
2020 January 03
NV
Надеемся на естественную интраверсию у многих разработчиков. И общую культуру "не отрывай другого от дела без необходимости"
+1, и есть ещё культура задавания хороших вопросов, в которую входит "сначала почитай командные доки и погугли"
NV
И ещё раз привет всем новым участникам )
2020 January 05
AZ
И ещё раз привет всем новым участникам )
\o/
AZ
Друзья, с наступившим всех новым годом! Желаю всего хорошего в новом году!
У меня есть желание составить картину мира форматов и инструментов, которые используются в повседневной работе для создания документации. Интересует создание и обработка текста. Уверен это будет интересно и полезно всем присутствующим. Давайте посмотрим как обстоят дела. Будет удобно обрабатывать данные, если вы сопроводите сообщение тэгом, например #usedoc. Начну с себя.
У меня есть желание составить картину мира форматов и инструментов, которые используются в повседневной работе для создания документации. Интересует создание и обработка текста. Уверен это будет интересно и полезно всем присутствующим. Давайте посмотрим как обстоят дела. Будет удобно обрабатывать данные, если вы сопроводите сообщение тэгом, например #usedoc. Начну с себя.
AZ
Аналитик, использую G Suite: google docs + google drive , confluence (markdown) #usedoc