Как написать отличный технический документ о криптовалюте

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

Технический документ, несомненно, является одним из наиболее важных аспектов проекта блокчейн, поскольку он всесторонне резюмирует цели, методы, процессы и ресурсы, необходимые для его успешного выполнения. Несмотря на важную роль, которую он играет, в огромном море криптовалют, которое сейчас наводняет рынок, существует удручающее количество проектов, которые не отражают в своих официальных документах информацию о своем raison d’etre..

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

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

Что такое технический документ?

В общих чертах, технические документы – это подробные руководства по проекту, продукту или услуге, в которых особое внимание уделяется техническим и отраслевым деталям. Он предназначен не для непрофессиональной аудитории, а для тех, кто знаком с конкретной отраслью. Это отчет, который представляет собой нерешенную проблему с решениями для ее преодоления..

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

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

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

Вы заметите, как высоко проекты оценивают свои технические документы, по тяжелым усилиям, приложенным для их публикации. Ссылки на техническую документацию гордо отображаются на заметных местах на веб-сайте, Twitter используется для объявления о выпуске технического документа и приветствуется оживленное обсуждение на Reddit..

Почему инвесторы внимательно изучают официальные документы о криптовалютах

Какую конкретную роль играет технический документ с точки зрения инвестора? Это даст лучшее представление об идеальном техническом документе, поскольку инвесторы составляют основную часть целевой аудитории..

Технический документ производит самое глубокое впечатление, показывая готовность команды искренне сообщить о самой причине своего существования. Хороший технический документ покажет, насколько хорошо подготовлена ​​команда и насколько сильна ее приверженность проекту. Технический документ – это документ, который команда должна поддерживать, поскольку она подвергается бдительной проверке со стороны спонсоров и потенциальных инвесторов..

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

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

Эти последние пункты предсказывают потенциальный успех или отсутствие такового проекта; это критерии, которые необходимо тщательно рассмотреть, если к проекту нужно относиться серьезно..

По этим причинам опытный инвестор внимательно изучает технические документы через увеличительное стекло. Конечно, новичку нелегко разобраться в техническом жаргоне, которым наполняется документация. Однако технический язык криптовалюты – это то, что крипто-энтузиаст со временем выучит. И примерно в свое время человек начинает ощущать адекватные технические возможности проекта и команды второй натурой..

Таким образом, технические документы – это убеждения, которые команда должна убедительно построить, чтобы выделить критерии логического существования, коммерческой жизнеспособности и технической надежности. Эти критерии должны быть соблюдены, по крайней мере, для того, чтобы заслужить доверие инвесторов – и многое другое, если он стремится к долгосрочному выживанию в долгом марафоне, которым является гонка криптовалют..

Конечно, это далеко не так просто, потому что, как мы уже говорили, технический документ должен сочетать авторитетную информацию о проекте, оставаясь при этом доступным для менее осведомленных умов государственных инвесторов. Он служит как введение, так и энциклопедия..

Как мы это делаем? Давайте разберемся, что необходимо для хорошего технического документа и как его написать..

Формат официального документа по криптовалюте

Технический документ – это официальный документ строгого формата. Общая схема обычно выглядит следующим образом:

• проблема представлена
• решения проблемы
• технология
• платформа и процессы, реализующие решение
• приложения (варианты использования) решения,
• команда
• Ресурсы

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

Тем не менее, это знак того, что команда будет продолжать придерживаться своего проекта, поскольку расчеты не так легко подделать. Вы не можете обмануть проницательных читателей ложными расчетами.

Технический документ обычно должен быть в формате PDF. Это связано с тем, что файлы PDF можно распространять, но их трудно редактировать. Он вынуждает автора (ов) тратить силы и уделять внимание его конструкции, поскольку в случае ошибки он наносит удар по его репутации. Работа, вероятно, была распространена, и формат PDF не поддается легким исправлениям..

Длина технического документа зависит от предлагаемой информации. Необязательно иметь длинный технический документ, превышающий 30 страниц – большее количество слов не означает более качественную информацию. Качество информации имеет первостепенное значение, и часто ее можно сократить до разумной длины. Легко заметить вздор и избыточность.

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

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

Что касается тона письма, он не должен сильно отклоняться в ту или иную сторону. Верно, что технический жаргон и академическая формулировка лучше подходят для описания технических документов, но должны быть некоторые соображения для более ясного изложения..

Академические объяснения по самой своей природе лучше подходят для технической архитектуры и решений, но их суть также должна быть резюмирована и передана в понятных аналогиях или удобных для новичков формулировках в какой-то момент статьи. Было бы упущением ограничить понимание важной части проекта несколькими избранными читателями..

Безусловно что технический документ не должен быть плагиатом. Это лень, нечестно и оказывает медвежью услугу читателям. Даже если вспомнить некоторые популярные аспекты официальных документов, такие как основы или история блокчейна, плагиат не годится..

Можно было бы предположить, что у команды есть опыт и письменные навыки, чтобы объяснить, что такое блокчейн, учитывая, что у них есть опыт и знания в этой области. Криптосообщество нелегко обмануть, и явная лень и некомпетентность будут быстро обнаружены..

Ключевые элементы технического документа по криптовалюте

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

Абстрактный

В исследовательской работе аннотация суммирует цель проекта, проблемы и решения в этой области, а также методы, используемые для достижения этого решения..

Тезисы не присутствуют в каждом техническом документе. Это более формальное включение, оно присутствует в научных статьях и часто отсутствует в официальных документах по криптовалюте. Заметным исключением является Технический документ о биткойнах, написано Сатоши Накамото, который включал реферат, в котором кратко рассматривалась проблема централизованных систем, решения проблемы двойных расходов, краткое описание метода и того, как он работает.

Хотя это не является абсолютно необходимым, аннотация предлагает читателям краткий обзор основных проблем проекта и решений. Если это вызовет их интерес, они могут продолжить чтение всего технического документа. Эти вступительные заявления экономят много драгоценного времени и повышают доверие к вашему проекту..

Вступление

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

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

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

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

Технический документ Ripple о протоколе консенсуса – отличный пример введения, уравновешивающего информацию и доступность. В целом, Ripple’s бумага короткая и милая.

Определения

Для дальнейшего облегчения понимания рекомендуется определить в техническом документе список важных и часто встречающихся терминов. Это будут технические термины и / или те, которые уникальны для рассматриваемого проекта. Это будет своего рода приложение для читателя, который сможет вернуться к нему для разъяснений при чтении технических разделов документа..

Например, здесь будут перечислены определения конкретных компонентов, участвующих в процессах платформы.. ICON’s (ICX) определение NEXUS и C-Rep это хорошо написанные определения, которые четко определяют их роли и функции, а также достаточно удобочитаемы.

Чтобы получить поучительный урок о том, как ловко с этим справиться, подумайте, как Zcash определил термины как формально, так и неформально в их технический документ. Это довольно тяжело по математике, но они также включают более простые определения для непрофессионального читателя..

Алгоритм консенсуса

Алгоритм консенсуса, являющийся неотъемлемой частью сети блокчейнов, требует подробного описания в техническом документе. Этот раздел обычно пишется в технической манере с сопровождающим математическим доказательством. Если алгоритм консенсуса в чем-то уникален, его можно сравнить с другими алгоритмами, что позволяет выделить его значимость. Преимущества можно выделить.

В этом разделе также следует описать фактический рабочий механизм алгоритма – как достигается согласие. Другие проблемы включают в себя то, как система защищает себя от внешних атак, таких как атака 51%. Если проект каким-то образом защищен от них, важно сообщить о них..

Решения

Здесь начинается настоящий технический разговор. Каждый блокчейн-проект имеет разные элементы, которые составляют общее решение поставленной проблемы. В этом разделе, объединенном под общим термином «Решения», потребуются подразделы, посвященные каждому отдельному компоненту решения..

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

Технический документ OmiseGo (OMG), с другой стороны, жонглирует ясностью и технической экспозицией. Обратите особое внимание на то, как они использовали пошаговый пример в разделе «Расчетная палата биткойнов» для объяснения процесса транзакции. Ему предшествует информация о том, что такое информационный центр и почему он существует, а также его роль в платформе проекта..

В этом разделе рассматриваются исследования и технические доказательства. Солидный проект, вроде ЙОТА, уверенно объясняет все его механизмы научными и математическими аргументами – то, что невозможно подделать.

Здесь нет никаких концепций – просто объяснение фактов. Если есть место для упрощенного и разумно разбавленного перевода, стоит сообщить.

Техническая архитектура и работа платформы

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

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

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

ЙОТА снова хороший пример хорошо объясненной технической архитектуры.

Информация о токене

Чтобы обеспечить полную прозрачность, проекты часто указывают свои источники финансирования и распределение в своих официальных документах. Инвесторы видят, куда будут потрачены их деньги, и детали системы токенов..

Эта часть технического документа предлагает чисто финансовую информацию о проекте. Перечислите детали любой финансовой поддержки, которая была получена, и укажите числовые значения токена. Взгляни на Технический документ TenX, который подробно объясняет детали продажи токенов и распределения финансирования.

Дорожная карта

Описав проект и его технические аспекты, пришло время объяснить потенциальным инвесторам дальнейший путь, намеченный командой..

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

Токен сети Golem предлагает хороший раздел дорожной карты что заслуживает подражания.

Сценарии использования / коммерческое приложение

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

Крайне важно описать, как проект будет реализован в коммерческих целях. В конце концов, проект может быть подкреплен надежными техническими и математическими характеристиками, но выгода от этого теряется, если она не выражена в относительной манере, с четкими материальными приложениями. Какие возможности для получения дохода у него есть? Какие результаты, по статистике, приносит внедрение технологии??

Также можно указать потенциальное деловое партнерство, которое ускорит внедрение и поможет распространить использование платформы, поскольку они также являются двумя очень важными аспектами потенциала проекта. По сути, это тот раздел, который убеждает инвесторов с точки зрения бизнеса..

Команда

Сообщество приятно слышать о людях, стоящих за проектом. Это помогает инвестору узнать об опыте и знаниях людей, управляющих проектом. Это распространяется на консультантов по проектам. Наличие группы известных консультантов может повысить доверие к проекту в глазах инвесторов..

Рекомендации

Это говорит само за себя. В справочном разделе перечислены различные использованные ресурсы и цитируются утверждения, сделанные в ходе подготовки технического документа..

Исходный код похож на второй технический документ

Многие образованные члены сообщества, и, конечно, разработчики среди них, знают, что то, что делает или ломает проект блокчейна, – это базовая технология, построенная на программировании..

Чтение исходного кода – незаменимый метод изучения проекта. В некотором смысле технический документ существует для перевода того, что присутствует в компьютерных языках, на человеческий язык. Тем не менее, важно знать, что при переводе можно многое потерять..

В блокчейне (и во многих других отраслях, учитывая, что мир становится все более цифровым) знание программирования является незаменимым навыком. Он обеспечивает большую ясность в проекте и помогает выявить несоответствия между предполагаемыми характеристиками проекта и его фактическим техническим развитием..

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

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

На этом поймают нечестный проект, а на искреннем это продемонстрируют. Не потому, что они прилагают сознательные усилия, чтобы обладать этими качествами, а потому, что они естественным образом воплощают эти качества, и это проявляется в их работе. Другими словами, это то, что нельзя подделать..

Почему так важны официальные документы о криптовалютах

На этом этапе должно быть ясно, что технический документ является неотъемлемым элементом криптовалютного проекта. Это письменное обязательство, размещенное на постоянной и глобальной платформе публикаций в Интернете, в отношении разрушительных и определяющих будущее эффектов, на которые направлен проект. Это действие положить деньги туда, где им говорят..

С практической точки зрения технический документ предназначен для привлечения инвесторов. Если проект и технический документ надежны, можно быть уверенным, что инвесторы, особенно хорошо информированные, распространят информацию о проектах с высоким потенциалом..

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

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

Вывод

Технические документы могут показаться сложной задачей, но они очень необходимы и в основном обязательны в сегодняшнем переполненном криптопространстве..

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

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

Этого нельзя сказать достаточно: технические документы имеют значение.

Вы начинаете проект блокчейна, для которого требуется технический документ? Инвестиции в блокчейн могут помочь! Свяжитесь с нами по электронной почте чтобы узнать.

Связанный: Как провести успешное ICO (часть 1): стоит ли вам вообще ICO?