Работал я как-то с огромной базой знаний, количество статей в которой исчислялось сотнями, а возможно и тысячами. В таких больших системах неизбежно находится много так называемой легаси-документации: старые тексты трёхлетней давности, авторы которых ныне пребывают за пределами видимой вселенной, опубликованные черновики, написанные на коленке заметки, статьи-лоскутные одеяльца, руку к которым приложило несколько авторов...Впору открывать парикмахерский салон, чтобы всё это причесать (вычитать, обновить и переписать). Но рабочее время полностью уходит на текущие задачи, поэтому актуализация доки часто оказывается в глубоком бэклоге.Тогда мы придумали сделать систему статусов, которые можно повесить на любую статью так, что сразу будет видно — в каком состоянии готовности и актуальности эта статья находится.Мы придумали четыре статуса:NEW — новая, свеженькая статья. Статус висел месяц после публикации.DRAFT — черновик статьи. Статус присваивался материалам, которые уже были опубликованы, но ещё дописывались.DEPRECATED — неактуальная статья. Статус обозначает, что статья описывает неработающую функциональность и в скором времени будет перенесена в архив.ACTUAL — хорошая, актуальная статья. По сути, такого статуса не существовало физически, любая статья, не отмеченная другими статусами, по умолчанию считалась actual.Прошло время — теперь я работаю в другом месте и совсем с другой базой знаний, которая создаётся почти с нуля и растёт прямо на моих глазах. Я решил разработать систему статусов и здесь, чтобы самого начала формировать прозрачную и понятную структуру. К уже известным ACTUAL, DRAFT и DEPRECATED добавил ещё два:REVIEW — статья содержит неактуальную информацию и находится в процессе обновления.LEGACY — статья больше не поддерживается, использовать на свой страх и риск.Надеюсь, это поможет мне поддерживать чистоту и порядок в своей доке, которая стремительно развивается и увеличивается в размерах. А вы используете статусы или их аналоги в работе с документацией? Расскажите о своём опыте, будет интересно обсудить)Дисклеймер: рекомендую относиться к статусам с осторожностью и использовать их только в случае реальной необходимости, иначе это может превратиться в ещё один бюрократический процесс, от которых мы так стараемся избавиться.P.S. Хочу выразить благодарность моей коллеге Ире за помощь и техническую поддержку 🕊#практика
Оставить комментарий/отзыв