Документирование Cardano: единый источник истины для разработчика, пригодный для будущего

Перевод статьи https://iohk.io/en/blog/posts/2020/07/01/documenting-cardano-a-single-source-of-developer-truth-fit-for-the-future/

1 июля 2020 года Tim Harrison

Со вчерашнего выпуска первой завершенной Shelley ноды в основной сети Cardano началась новая эра. Помимо сегодняшнего внедрения совершенно нового веб-сайта Cardano и фирменного стиля, а также завтрашнего виртуального саммита Cardano Virtual Summit, развертывание эпохи Shelley проливает свет на будущее компании IOHK. Оно также подчеркивает необходимость создания системы документации, пригодной для нашей быстро растущей экосистемы.

За эти годы мы написали и собрали значительное количество технических материалов по Cardano. Неизбежно то, что этот процесс развивался органически и имел переменное качество и полезность. Не все эти материалы остаются точными или полезными. Развертывание Shelley, рост интереса разработчиков и эволюция Cardano переместили нас из проекта в продукт. Таким образом, это создало необходимость по-новому взглянуть на то, как мы воспринимаем и объясняем Cardano.

Пользователи и потребители Cardano должны иметь четкий, лаконичный и релевантный материал, соответствующий качеству кода, на котором построен блокчейн. Документация должна быть правильной и полезной, хорошо организованной и целенаправленной. Кроме того, мы определили необходимость отображения категорий информации для каждой группы пользователей или отдельно взятой личности. Мы создаем лучший в своем классе блокчейн, и это требует высококачественной подтверждающей документации. Старый сайт документации Cardano нуждался в серьезной реорганизации и обновлении, и наши технические писатели были заняты именно этим. Добро пожаловать в новый Cardano docs.

Документация для будущего

Cardano - это сложный продукт со сложной технологической основой. Однако для того, чтобы сообщество разработчиков и более широкая аудитория приняли его, нам нужно, чтобы они поняли, каким образом он может обеспечить полезный опыт. Они должны знать, на что способна сеть Cardano и на сколько она может быть полезна в решении проблем. Чтобы гарантировать, что у нас есть верная информация для всех пользователей, мы реорганизуем пакет документации для отражения потребностей каждой аудитории.

В течение последних нескольких месяцев IOHK была вовлечена в общекорпоративные усилия по обновлению всего контента о проекте Cardano. Наша команда технических писателей была погружена в преобразование нашего предыдущего репозитория, тесно сотрудничая с нашими командами разработчиков с целью создания единого источника технической правды, - ресурса эффективной, информативной и актуальной информации, которая представляет собой определенную ценность для широкого круга аудитории: партнеров по обмену, стейк пулов, опытных разработчиков блокчейна, а также людей, которые хотят понять Cardano. К тому же, этот ресурс будет удовлетворять интересы как опытных крипто-энтузиастов, так и тех, кто просто хочет что-то узнать о Cardano с технической точки зрения.

Поэтому сегодня мы запускаем новый сайт документации. Вместо статического репозитория сайт теперь является живым, дышащим источником информации о Cardano, подключенным к сердцу нашей методологии разработки. Как и Cardano, это постоянно развивающийся элемент. Компоненты добавляются регулярно, поскольку мы стремимся улучшить контент, который мы предоставляем. Все время внедряются новые функциональные возможности. Мы также намерены публиковать гораздо больше документации, основанной на наших будущих планах и обратной связи с сообществом. Мы должны строить контент, беря за основу то, что необходимо для наших пользователей, независимо от того, сидят ли они в технологическом или коммерческом пространстве.

Как член сообщества Cardano, вы можете принять участие и помочь нам улучшить нашу документацию с помощью определенного репозитория GitHub. Благодаря виртуальному саммиту и нашей продолжающейся динамике развития, привлекающим множество новых лиц в экосистему, у нас теперь есть точка отсчета для единственного источника истины разработчика, от которой мы можем отталкиваться.

// От переводчика: для получения дополнительных переведенных на русский язык статей о Cardano посетите русскоязычный раздел на форуме Cardano. Видеоролики о Cardano на русском можно найти на YouTube канале нашего замечательного амбасадора Тимура Сахабутдинова. Хотите поговорить или задать вопрос о Cardano по-русски? Приглашаем вас в наше уютное сообщество в Telegram. Оставайтесь на связи, все будет хорошо!