Создание и редактирование документов

Создание и редактирование документов

Документы в AB Projects — это страницы Markdown с полной историей версий. Создание и редактирование происходят в боковой панели с предпросмотром в реальном времени, и каждое изменение записывается, поэтому команда всегда знает, что изменилось и почему.

Создание страницы

• В разделе Документы проекта начните новую страницу. Задайте ей заголовок, необязательный родительский путь (по умолчанию / — укажите что-то вроде onboarding, чтобы вложить её) и необязательные теги.
• Напишите содержимое в формате Markdown. В редакторе рядом с исходным текстом отображается предпросмотр в реальном времени, чтобы вы видели итоговый результат по мере ввода.
• Сохраните, чтобы опубликовать страницу в дереве. Она становится версией 1.

Редактирование страницы

• Откройте страницу и выберите Редактировать (из меню действий страницы). Открывается та же панель с текущим Markdown.
• При редактировании требуется примечание к правке. Перед сохранением изменения вы должны ввести краткое примечание, описывающее, что изменилось — если вы оставите его пустым, AB Projects попросит вас добавить его, «чтобы ваша команда знала, что изменилось». (Новым страницам примечание не нужно; правкам — нужно.)
• Сохранение создаёт новую версию, а не перезаписывает существующую — предыдущая версия сохраняется.

История версий и восстановление

• Каждая страница отслеживает номер версии, а также последнего редактора и время.
• Откройте Историю из меню действий страницы, чтобы увидеть прошлые версии, каждую с её примечанием к правке — так «почему» каждого изменения зафиксировано.
• Вы можете восстановить более раннюю версию из списка истории. Восстановление возвращает это содержимое как текущую страницу (и само записывается как новая версия).

Удаление страницы

• Удаление доступно из меню действий страницы и намеренно размещено отдельно от «Редактировать»/«История», чтобы по нему не нажали случайно.
• Удаление убирает страницу из дерева. Относитесь к этому как к действию, требующему осторожности — предпочитайте редактирование или восстановление удалению, когда вам нужно лишь изменить содержимое.

Советы

• Используйте родительский путь, чтобы построить понятную структуру (например, engineering/runbooks), вместо плоского списка страниц.
• Пишите содержательные примечания к правкам — именно их показывает «История» и именно на них полагаются коллеги, чтобы понять изменение без сравнения версий.
• Используйте предпросмотр в реальном времени, чтобы проверить форматирование (заголовки, блоки кода, ссылки) перед сохранением.
• Если правка получилась неудачной, восстановите предыдущую версию из «Истории», а не переписывайте по памяти.

Благодаря Markdown, предпросмотру в реальном времени, обязательным примечаниям к правкам и полной истории с восстановлением документы остаются простыми для написания и безопасными для изменения.