НК
Может меня тут затыкают, но как по мне, таблички — не панацея...
Я об этом хотел сказать.
Я об этом хотел сказать.
хз. не знаю. опытные говорят, что таблички повышают читаемость.
Size: a a a
2020 July 30
И
Ну вот как я пришёл - у нас не было чёткого формата как писать документацию. Было только "Чтобы всем было понятно и удобно". И вот я сейчас пытаюсь выработать какой-то общий шаблон, который можно будет взять и применять для написания всей дальнейшей документации.
Так походу "чтобы всем было понятно и удобно" и есть единственный стандарт😄
Согласен с @Alderfly по поводу однотипной фичи.
По факту ты взял все особенности и вынес в таблицу, но, как мне кажется, тут хотят сказать, что если фича будет большая, то таблица не вывезет
Согласен с @Alderfly по поводу однотипной фичи.
По факту ты взял все особенности и вынес в таблицу, но, как мне кажется, тут хотят сказать, что если фича будет большая, то таблица не вывезет
AG
Таблицы в документах вообще зло. Все таблицы нужно выносить отдельно в таблицы.
И
Я когда работал брал самые удачные на мой взгляд образцы, опыт других людей и переносил в notion, форматировал и перекрещивал ссылками. Не жаловались и даже работали по этой документации.
Но в остальные проекты не хватает навыков, поэтому я сделал вывод, что это все от случая к случаю и только обладая охранительным опытом можно стандартизировать что-либо, да и то в голове только...
(Но это так, просто рассуждения, конечно)
Но в остальные проекты не хватает навыков, поэтому я сделал вывод, что это все от случая к случаю и только обладая охранительным опытом можно стандартизировать что-либо, да и то в голове только...
(Но это так, просто рассуждения, конечно)
НК
У нас есть отличная статья о документации, я не понимаю откуда вот эти все изобретения появляются https://gdcuffs.com/gd-workflows-pipelines/
а ты Структуру документа описания фичи пишешь по шаблону из этой статьи?
WR
нарыл свой шаблон на ГДД https://docs.google.com/document/d/16rNWsZFWP_kn4U9_Sdd3RdaFRk8GUBkdtMkSytuzIgU/edit
@Nikita_Krasov посмотри
@Nikita_Krasov посмотри
НК
нарыл свой шаблон на ГДД https://docs.google.com/document/d/16rNWsZFWP_kn4U9_Sdd3RdaFRk8GUBkdtMkSytuzIgU/edit
@Nikita_Krasov посмотри
@Nikita_Krasov посмотри
спс
WR
он чутка подустарел уже, я сейчас другим пользуюсь. Но в парадигме "гд отвечает за все" - норм вариант. Удаляешь разделы, которые для вас неактуальны, добавляешь какие-то специфичные штуки и можно юзать
НК
агась. уже изучаю. спасибо.
ǭ
Может меня тут затыкают, но как по мне, таблички — не панацея...
Я об этом хотел сказать.
Я об этом хотел сказать.
Таблицы спасают жизни!!
ǭ
Я когда работал брал самые удачные на мой взгляд образцы, опыт других людей и переносил в notion, форматировал и перекрещивал ссылками. Не жаловались и даже работали по этой документации.
Но в остальные проекты не хватает навыков, поэтому я сделал вывод, что это все от случая к случаю и только обладая охранительным опытом можно стандартизировать что-либо, да и то в голове только...
(Но это так, просто рассуждения, конечно)
Но в остальные проекты не хватает навыков, поэтому я сделал вывод, что это все от случая к случаю и только обладая охранительным опытом можно стандартизировать что-либо, да и то в голове только...
(Но это так, просто рассуждения, конечно)
покажи из каких ты собирал.
нам как раз сейчас надо хороших примеров гдд в соседнем чате.
нам как раз сейчас надо хороших примеров гдд в соседнем чате.
И
покажи из каких ты собирал.
нам как раз сейчас надо хороших примеров гдд в соседнем чате.
нам как раз сейчас надо хороших примеров гдд в соседнем чате.
Я не утверждаю, что они хорошие)
Они понятные для меня, хорошие на мой взгляд)
Могу в ЛС скинуть кое-чего
Они понятные для меня, хорошие на мой взгляд)
Могу в ЛС скинуть кое-чего
ǭ
да, давай.
К
нарыл свой шаблон на ГДД https://docs.google.com/document/d/16rNWsZFWP_kn4U9_Sdd3RdaFRk8GUBkdtMkSytuzIgU/edit
@Nikita_Krasov посмотри
@Nikita_Krasov посмотри
Первое, что бросается в глаза. Первый пункт идет про "Зачем мы это делаем?"
WR
Первое, что бросается в глаза. Первый пункт идет про "Зачем мы это делаем?"
ну да. А почему это бросается в глаза? Самый важный вопрос ведь
AV
хз. не знаю. опытные говорят, что таблички повышают читаемость.
Читаемость повышают буллеты без лишней воды :)
AV
а ты Структуру документа описания фичи пишешь по шаблону из этой статьи?
У меня свой шаблон, выработанный годами
WR
таблички тоже норм, если сделать красиво ) типа когда стейты какого-то элемента сравниваешь и надо ряд однотипных состояний сравнить - ок. Но я обычно убираю в таких случаях видимость границ, меня эти тонкие черные линии таблиц вордовских вымораживают
WR
но лично у меня сейчас приоритет на понятности + кратости дока. Если таблица поможет - фигачу таблицу, если нет - то нет