Общие принципы работы с документацией
Эта страница переведена сообществом на русский язык, но нуждается в улучшениях. Если вы хотите принять участие в переводе свяжитесь с @alexgton.
Эта страница устарела и скоро будет удалена. См. Как внести вклад.
Для обеспечения оптимального взаимодействия с пользователем и ясности, пожалуйста, помните о списке общих и важных требован ий, которые мы стремимся применять ко всей документации на docs.ton.org при создании нового контента.
Документация, созданная для профессионалов
Страницы документации в первую очередь предназначены для документирования, а не как учебное пособие, поэтому важно свести к минимуму использование личных примеров или аналогий в тексте. Важно убедиться, что содержание подходит как для профессионалов, так и непрофессионалов, и при этом содержит ценную информацию.
Используйте единый формат
Чтобы читателям было легче ориентироваться в документации, важно использовать единый формат во всем документе. Используйте заголовки, подзаголовки, маркеры и нумерованные списки, чтобы разбить текст и сделать его более удобным для чтения.
Приведите примеры в специальном разделе
Приведите примеры в специальном разделе Приведение примеров может помочь читателям лучше понять контент и то, как его применять. Если вы пишете страницу документации и вам нужно сослаться на несколько примеров, пожалуйста, создайте специальный раздел "Примеры" прямо перед разделами "Ссылки" и "См. также". Не смешивайте описание и примеры на страницах документации. Используйте фрагменты кода, снимки экрана или диаграммы, чтобы проиллюстрировать свои соображения и сделать документацию более интересной.
Поддерживайте ее актуальность
Техническая документация может быстро устареть из-за изменений в технологиях или обновлений программного обеспечения. Важно регулярно просматривать и обновлять документацию, чтобы она оставалась точной и соответствующей текущей версии программного обеспечения.
Получите обратную связь
Перед публикацией документации рекомендуется получить обратную связь от других участников или пользователей. Это может помочь выявить области, которые могут вызывать путаницу или неясность, и позволит вам внести улучшения до выхода документации.