IOHKブログ:Cardanoの文書化:将来に適した、開発の真実を伝える単一情報源

2020年7月1日 Tim Harrison 読了時間3分

昨日、Cardanoメインネットに初めて完全なShelleyノードがリリースされたことにより、新時代が幕を開けました。本日最新のCardanoウェブサイトとブランドアイデンティティが立ち上がり、明日はCardanoバーチャルサミットが開催されるなど、Shelleyの夜明けはIOHKの未来にフレッシュな光を投げかけています。これと同時に、急速に成長するエコシステムにふさわしいドキュメンテーションフレームワークの必要性も強調されてきました。

私たちは数年間にわたり、Cardanoに関する膨大な技術資料を執筆、収集してきました。必然的にこうした文書は有機的に発展しており、質や有効性にばらつきがあります。すべてが正確かつ有益であり続けるわけではありません。Shelleyのデプロイ、開発者の関心の拡大、そしてCardanoの進化に伴い、プロジェクトはプロダクトへと変容しました。そして、Cardanoの説明方法にについても見直す必要が生じたのです。

Cardanoのユーザーや消費者は、ブロックチェーンが基盤としているコードの質にマッチした、明確で簡潔、かつ関連性のある資料を必要としています。ドキュメンテーションは正確かつ有益、そしてきちんと焦点を当て、整理されたものである必要があります。加えて、ユーザーグループ、あるいは使用する用途に応じて、情報を明確にカテゴリー分けする必要もあるでしょう。私たちは最高レベルのブロックチェーンを構築していますが、これにはその根拠を示す質の高い文献資料が不可欠です。これを受けて、IOHKのテクニカルライターたちは旧Cardano docsサイトの大幅な再編および更新に没頭しました。新しいCardano docsサイトをお楽しみください。

未来のためのドキュメンテーション

Cardanoは複雑な技術に支えられた複雑なプロダクトです。しかしながら、これを取り巻く開発者コミュニティと幅広い使用者に、その満足感を得られる経験がいかに提供されているかを理解してもらう必要があります。Cardanoができること、そして問題をいかに解決できるかを知ってもらう必要です。そこですべてのユーザーに正しい情報を届けるために、一連の文献を再編し、各使用者のニーズに合わせて整理しました。

この数か月、IOHKはCardanoプロジェクトに関する全コンテンツの改良を全社を挙げて進めてきました。テクニカルライティングチームは、開発チームと密接に協力し合い、技術的真実を伝える単一情報源として旧リポジトリを改造。取引所パートナー、ステークプール、経験豊富なブロックチェーン開発者、そしてCardanoを理解したいと望む人々といった幅広い利用者を対象に価値を提供する、有効かつ有益な最新情報のリソース作りに邁進しました。もちろん、高いスキルを持つ暗号愛好家や単にCardanoの技術的側面を学びたいと望む人々にも役立ちます。

本日、新しいドキュメンテーションサイトが公開されます(現在英語のみ)。静的なリポジトリに代わり、このサイトは、開発手法の心臓部に差し込まれた、息遣いが聞こえるほどの生きたCardano情報源です。Cardano同様、進化を続けるサイト。配信するコンテンツを改良するため、コンポーネントは定期的に追加されます。新機能は常に実装され、プランやコミュニティからのフィードバックに基づき、より多くのドキュメンテーションを公開していく予定です。このサイトは、技術面や商業面など異なる視点に立つユーザーたちに役立つよう構築されなければなりません。

このドキュメンテーション改良プロセスには、Cardanoコミュニティのメンバーとして専用GitHubから参加することができます。バーチャルサミットや、エコシステムに新たな人材をもたらす機会を進めながら、私たちは今、構築の基盤となる開発の真実を伝える単一情報源の出発点を手にしたのです。

2 Likes