Руководство по стилю документации
Эта страница переведена сообществом на русский язык, но нуждается в улучшениях. Если вы хотите принять участие в переводе свяжитесь с @alexgton.
Введение
Это руководство призвано помочь вам определить вашу аудиторию, которая повлияет на стиль и размещение вашего контента.
Аудитория
Документация TON (docs.ton.org) — это ресурс, разработанный для трех основных аудиторий.
Концепции для отдельных лиц: Независимо от того, являются ли читатели новыми пользователями приложений, инвесторами или энтузиастами блокчейна, они найдут ответы на свои вопросы о надежности TON, возможностях кошелька, вовлеченности сообщества и технической дорожной карте. Концепции упрощают сложные абстракции, чтобы читатели могли уверенно вникать в суть.
Рекомендации для внешних разработчиков: Читатели могут узнать, как запускать узлы, быстро создавать примеры проектов и интегрировать свои проекты с TON — все это представлено в виде простых пошаговых инструкций. Для разработчиков, которые практически не имеют опыта работы с блокчейном, этот материал представляет собой практическое введение в технологический стек TON.
Документация для разработчиков TON: Раздел документации посвящен улучшению опыта разработчиков с помощью глубокой и подробной документации. Здесь технические эксперты могут озна комиться с лучшими практиками и технической информацией для разработки смарт-контрактов промышленного уровня и приложений для глобального рынка. Это также руководство для тех, кто планирует улучшить программное обеспечение для блокчейна и обновить протоколы TON.
Концепции для отдельных лиц
Пользователи приложений, инвесторы, энтузиасты или все, кто впервые знаком с блокчейном и TON
Примерные пути развития:
- “Я хочу проверить надежность TON и, ответив на несколько основных вопросов, попробовать его использовать.”
- “Я знаю, что мне нужен кошелек TON, и я хочу узнать, как он работает.”
- “Я хочу получить представление об активности сообщества TON, чтобы решить, достаточно ли оно активно, чтобы я мог обратиться за помощью в случае необходимости.”
- “Я в восторге от TON и хочу принять участие, но не знаю, что делать дальше.”
- "Я хочу узнать о технической дорожной карт е TON."
Рекомендации для внешних разработчиков
Примерные пути развития для внешних разработчиков:
- “Я разработчик, но у меня нет опыта в криптографии, и я хочу разобраться в технологическом стеке TON.”
- “Я хочу научиться управлять узлом TON/”
- “Я хочу быстро запустить пример проекта TON, чтобы понять, насколько сложно или легко создать настоящий проект на TON.”
- "Я начал работать над интеграцией своего проекта в TON и хочу выяснить, как это сделать лучше всего.”
Документация для разработчиков TON
Примерные пути развития для разработчиков TON:
- "Я хочу разработать п ромышленные смарт-контракты для экосистемы TON в соответствии с передовой практикой и спецификациями."
- "Я хочу участвовать в разработке программного обеспечения блокчейна TON."
- "Я хочу обновить протоколы TON, чтобы улучшить пользовательский опыт."
- "Я хочу обновить спецификацию TON, чтобы повысить удобство работы для разработчиков."
Рекомендации по стилю
В этом разделе описываются лучшие практики для концепций, руководств и разделов документации. Концепции и руководства используют схожий подход.
Концепции и рекомендации
Это общие проблемы контента для читателей концепций и руководств.
Распространенные проблемы с контентом:
- Перегруженность специфическими техническими терминами
- Несогласованность содержания на разных страницах
- Статьи трудно усваиваются из-за того, что
- Содержание слишком абстрактно и оторвано от реальности
- Слишком много текста на странице и абзаце
- Использование сложных предложений
- Слишком большое количество ссылок может привести к перегрузке читателей, в результате чего они покинут веб-сайт
Чтобы контент соответствовал своей аудитории, соблюдайте следующие правила.