E
кстати, где-то в интернетах есть гайд по организации документации docs-as-code? каких специалистов нужно привлечь, чему научиться?
Size: a a a
2020 October 27
E
но только понятный )) а то я в этом смысле "пользователь туп", мне могут понадобиться очевидные вещи...
H
кстати, где-то в интернетах есть гайд по организации документации docs-as-code? каких специалистов нужно привлечь, чему научиться?
Поднимался этот вопрос уже. Сходите к Тому Джонсону.
Поиск по истории решает.
Поиск по истории решает.
E
Поднимался этот вопрос уже. Сходите к Тому Джонсону.
Поиск по истории решает.
Поиск по истории решает.
а, спасибо )
CV
Fox Mulder
хаос и дедлайны меня не пугают, они неизбежное зло. А вот:
госы - мы не понимаем в ваших докерах, шмокерах. И вообще, вы пользовательскую документацию пишите слишком понятно для пользователя, перепишите.
менеджеры - а что это у вас код разноцветный, исправить на ч.б. Текс какой-то не формализированный - вы писатель или где, учитесь у депутатов. А вот еще задача, мне ее дали год назад, но тебе надо за 1 день сделать всю документацию по проекту.
госы - мы не понимаем в ваших докерах, шмокерах. И вообще, вы пользовательскую документацию пишите слишком понятно для пользователя, перепишите.
менеджеры - а что это у вас код разноцветный, исправить на ч.б. Текс какой-то не формализированный - вы писатель или где, учитесь у депутатов. А вот еще задача, мне ее дали год назад, но тебе надо за 1 день сделать всю документацию по проекту.
Когда долго кипело внутри и нашло выход наружу)
FM
Когда долго кипело внутри и нашло выход наружу)
Да не, меня уже ничем уже не удивишь )) Все сценарии абсурдных вещей пройдены )
CV
Fox Mulder
Ну а вы когда юридические статьи читаете или там законы, вам понятно?
Я вот чувствую себя дебилом, когда читаю фстековские документы. Вот сижу, читаю, не понимаю. Читаю ещё раз. И вроде не дурак ,а вот читаю, не понимаю и чувствую дураком. И законы так же и т.д.
Так делают специально, я тоже так умею и делаю. Когда на отвали или чтобы запутать.
Я вот чувствую себя дебилом, когда читаю фстековские документы. Вот сижу, читаю, не понимаю. Читаю ещё раз. И вроде не дурак ,а вот читаю, не понимаю и чувствую дураком. И законы так же и т.д.
Так делают специально, я тоже так умею и делаю. Когда на отвали или чтобы запутать.
К первому тезису: скорее накладывается «специфичность» используемого языка (как и у, например, медиков), но и сам «продукт» [документы, законы и пр.] может быть с недостатками.
С тем же «Гбайт» сколько полемики)
С тем же «Гбайт» сколько полемики)
PL
Всем привет
Ментор в задании попросила пересмотреть использование слова «база знаний» (это был англ вариант knowledge base) - мол что это за слово, что значит? Замени на то, что пользователи поймут.
И я зависла, ведь столько времени и пополняла сама базу знаний и сколько баз конкурентов пересмотрела...
А потом давай ресечить гигантов - и у них у всех такая «база» называется Help center, центр помощи
Мне немного непривычно такое использование, и в чем тогда существенная разница? Почему некоторые называют центрами помощи, а некоторые базой знаний?
—
п.с да, если вдруг интересно что это за задание было - придумать приложение и написать письмо-анонс
в последнем предложении я написала - «если будут вопросы узнать больше можно в базе знаний или обратитесь нам в поддержку.»
не думаю что мне в будущем реально интересно писать такие письма и на ходу выдумывать приложения чтобы писать не воду. не та «дорожка» по которой хотелось бы идти, но «зачёт» получить все равно нужно по заданию
Ментор в задании попросила пересмотреть использование слова «база знаний» (это был англ вариант knowledge base) - мол что это за слово, что значит? Замени на то, что пользователи поймут.
И я зависла, ведь столько времени и пополняла сама базу знаний и сколько баз конкурентов пересмотрела...
А потом давай ресечить гигантов - и у них у всех такая «база» называется Help center, центр помощи
Мне немного непривычно такое использование, и в чем тогда существенная разница? Почему некоторые называют центрами помощи, а некоторые базой знаний?
—
п.с да, если вдруг интересно что это за задание было - придумать приложение и написать письмо-анонс
в последнем предложении я написала - «если будут вопросы узнать больше можно в базе знаний или обратитесь нам в поддержку.»
не думаю что мне в будущем реально интересно писать такие письма и на ходу выдумывать приложения чтобы писать не воду. не та «дорожка» по которой хотелось бы идти, но «зачёт» получить все равно нужно по заданию
У нас внутренняя база знаний называется вики ("*имя компании* wiki"). Исходили из того, что все пользуются википедией и понять, что такое wiki, проще, чем осознать "базу знаний". Из того, что видела у других, Help center больше используется для внешних пользователей. Для внутренних пользователей - knowledge base или опять же wiki
V
У нас тоже wiki
SR
Fox Mulder
Это не про одно место работы, а вообще про все.
На одном из мест работы мне прям прямо заявили - документацию надо писать так, чтобы было непонятно.
===
Я вообще считаю это большой проблемой российской ИТ-индустрии - нежелание меняться, осваивать новые технологии и не бояться экспериментировать.
Причём этому подвержены не только госы или мелкие ИТ-компании, даже крупные ИТ-гиганты боятся отойти от правил: одни считают что пользователь туп (так и есть) и надо писать очевидные вещи, другие - мы не будем использовать в документации комиксы (там где это можно).
===
Использовать docs-as-code? Слишком сложно, будем юзать ворд! Внедрить spring на всей цепочке разработке? Нет! У нас тут легаси на дельфи!
На одном из мест работы мне прям прямо заявили - документацию надо писать так, чтобы было непонятно.
===
Я вообще считаю это большой проблемой российской ИТ-индустрии - нежелание меняться, осваивать новые технологии и не бояться экспериментировать.
Причём этому подвержены не только госы или мелкие ИТ-компании, даже крупные ИТ-гиганты боятся отойти от правил: одни считают что пользователь туп (так и есть) и надо писать очевидные вещи, другие - мы не будем использовать в документации комиксы (там где это можно).
===
Использовать docs-as-code? Слишком сложно, будем юзать ворд! Внедрить spring на всей цепочке разработке? Нет! У нас тут легаси на дельфи!
"Я вообще считаю это большой проблемой российской ИТ-индустрии - нежелание меняться, осваивать новые технологии и не бояться экспериментировать".
Ну да. Давно ты КОБОЛ-68 в российской индустрии видел? А карту тебе прокатывали физически с оттиском на кальке в России?
Как примитивный пример: в Android 10 появилась тёмная тема. На Windows она была в 13-м году. Значит ли это, что у Google в целом нежелание меняться?
В автомобилях используются шины 83-го года разработки, а уж про ОС для них вообще можно книгу абсурда писать.
Так что проблема в том, что ИТ-индустрия слишком широка, не все готовы меняться везде и сразу.
Ну да. Давно ты КОБОЛ-68 в российской индустрии видел? А карту тебе прокатывали физически с оттиском на кальке в России?
Как примитивный пример: в Android 10 появилась тёмная тема. На Windows она была в 13-м году. Значит ли это, что у Google в целом нежелание меняться?
В автомобилях используются шины 83-го года разработки, а уж про ОС для них вообще можно книгу абсурда писать.
Так что проблема в том, что ИТ-индустрия слишком широка, не все готовы меняться везде и сразу.
FM
"Я вообще считаю это большой проблемой российской ИТ-индустрии - нежелание меняться, осваивать новые технологии и не бояться экспериментировать".
Ну да. Давно ты КОБОЛ-68 в российской индустрии видел? А карту тебе прокатывали физически с оттиском на кальке в России?
Как примитивный пример: в Android 10 появилась тёмная тема. На Windows она была в 13-м году. Значит ли это, что у Google в целом нежелание меняться?
В автомобилях используются шины 83-го года разработки, а уж про ОС для них вообще можно книгу абсурда писать.
Так что проблема в том, что ИТ-индустрия слишком широка, не все готовы меняться везде и сразу.
Ну да. Давно ты КОБОЛ-68 в российской индустрии видел? А карту тебе прокатывали физически с оттиском на кальке в России?
Как примитивный пример: в Android 10 появилась тёмная тема. На Windows она была в 13-м году. Значит ли это, что у Google в целом нежелание меняться?
В автомобилях используются шины 83-го года разработки, а уж про ОС для них вообще можно книгу абсурда писать.
Так что проблема в том, что ИТ-индустрия слишком широка, не все готовы меняться везде и сразу.
Стас, Кобол не видел, Дельфи видел )
Темная тема в виндовз? Имеется ввиду themes? Это всё-таки немного другое.
Про шины вообще дикий прогресс. Сегодняшние шины дадут колоссальную фору шинам 83 года.
)
Темная тема в виндовз? Имеется ввиду themes? Это всё-таки немного другое.
Про шины вообще дикий прогресс. Сегодняшние шины дадут колоссальную фору шинам 83 года.
)
CV
NASTYA Dm
Всем привет! Опубликовала вчера статью, может кому-то будет интересно: https://habr.com/ru/company/aktiv-company/blog/524838/
Можно несколько комментариев к статье?
1. Было бы хорошо во вступительной части статьи добавить, что вы понимаете под «эфективным документом»
2. Почему пользователь приходит обязательно с негативом при открытии документа?
3. В блоке «Контраст» речь скорее о выделении, а не о контрасте в его понимании
4. В блоке «Приближенность» почему речь еще идет о «выравнивании». Отсутствие примера «приближенности»
5. В «Верстке» добавить бы примеров
6. В «Переносах» в списке булет потерялся последний
7. В последнем блоке используете термин «антипример», ранее использовали «как надо делать». Тем самым нарушаете сами свой же принцип «повторения»
Но чем больше статей на тему документации, тем лучше 👍
1. Было бы хорошо во вступительной части статьи добавить, что вы понимаете под «эфективным документом»
2. Почему пользователь приходит обязательно с негативом при открытии документа?
3. В блоке «Контраст» речь скорее о выделении, а не о контрасте в его понимании
4. В блоке «Приближенность» почему речь еще идет о «выравнивании». Отсутствие примера «приближенности»
5. В «Верстке» добавить бы примеров
6. В «Переносах» в списке булет потерялся последний
7. В последнем блоке используете термин «антипример», ранее использовали «как надо делать». Тем самым нарушаете сами свой же принцип «повторения»
Но чем больше статей на тему документации, тем лучше 👍
MS
Можно несколько комментариев к статье?
1. Было бы хорошо во вступительной части статьи добавить, что вы понимаете под «эфективным документом»
2. Почему пользователь приходит обязательно с негативом при открытии документа?
3. В блоке «Контраст» речь скорее о выделении, а не о контрасте в его понимании
4. В блоке «Приближенность» почему речь еще идет о «выравнивании». Отсутствие примера «приближенности»
5. В «Верстке» добавить бы примеров
6. В «Переносах» в списке булет потерялся последний
7. В последнем блоке используете термин «антипример», ранее использовали «как надо делать». Тем самым нарушаете сами свой же принцип «повторения»
Но чем больше статей на тему документации, тем лучше 👍
1. Было бы хорошо во вступительной части статьи добавить, что вы понимаете под «эфективным документом»
2. Почему пользователь приходит обязательно с негативом при открытии документа?
3. В блоке «Контраст» речь скорее о выделении, а не о контрасте в его понимании
4. В блоке «Приближенность» почему речь еще идет о «выравнивании». Отсутствие примера «приближенности»
5. В «Верстке» добавить бы примеров
6. В «Переносах» в списке булет потерялся последний
7. В последнем блоке используете термин «антипример», ранее использовали «как надо делать». Тем самым нарушаете сами свой же принцип «повторения»
Но чем больше статей на тему документации, тем лучше 👍
2. Потому что никто не любит читать инструкции)
ND
про 2ое есть во второй статье
ND
Вот поэтому не пишу часто статьи
FM
2. Потому что никто не любит читать инструкции)
Собирал шкаф. Не собирается.
Открыл инструкцию. Почитал.
Собрал шкаф. Доволен.
Открыл инструкцию. Почитал.
Собрал шкаф. Доволен.
CV
2. Потому что никто не любит читать инструкции)
Оценочная категория)
ND
у меня потом глаз дёргается
ND
сколько нервов, чтобы утвердить её в компании
ND
и потом ещё комментарии