WSOFTのドキュメントの WSOFT Docs への移行に関する情報

この記事では、WSOFTの提供している、あるいは提供していた、あみうは、WebSailing-Net、AliceScriptWikiおよび、WSOFTがwsoft.gq上で公開していたすべての記事の、WSOFTDocsへの移行に関する情報をお知らせします。

WSOFTは、今後数か月かけて記事やコンテンツの構造、形式、および基盤となるシステムを徹底的に見直し、WSOFTの提供するコンテンツを一つのサイトに一元化する全プロジェクト共通の取り組みを実施します。

AmebaOwandからWSOFTCMS、さらにWSOFTDocsへ

2018年、WebbSailingのサポート記事提供の場として、WebSailing-Netが誕生しました。WebSailingが、NX系に移行するまでの間、21の記事がAmebaOwandによってホストされました。

WSTubeの開発に際して、WSOFTは、自前でサーバーを用意し、そこで記事を提供する方式が導入されました。そこで、WSOFTはWSTubeで設計したUIを流用し、WSOFTCMSを開発しました。現在でも、WSOFTScriptのサイトで体験することができます。WSOFTは、この方式を3年以上にわたって使用し続け、その結果、200を超える記事がWSOFTCMSを通じて提供されました。

新しいドキュメント管理方法

ソフトウェアの多様化やリリースサイクルの短縮につれて、見やすくできるだけ最新のドキュメントを提供する必要が増大しました。記事の執筆を開発のスピードに合わせる必要があり、さらに、サポートが終了しているプロジェクトの資産を未だに使用し続けていることなどから、WSOFTでの近代的なドキュメント管理方法を再検討することに決めました。新しいプロジェクトには次の事項が求められます。

・ドキュメントの集約 新しいサイトでは、WSOFTが提供しているすべての記事を一つのサイトに集約します。例えば、AliceScriptを使ってWSPluginを設計しようとしている開発者は、WebSailing、WSPlugin、AliceScriptに関連するすべての記事やヘルプを検索することができます。

・ユーザー体験の向上 WSOFTCMSは、WSTube譲りのユーザーインターフェースやレスポンシブデザインへの前提的な対応など、お世辞にも使いやすいものとは言えませんでした。しかし、すべての記事は、みなさまに提供するために執筆されているため、みなさまにとって使いやすいものである必要があります。新しいサイトでは、読みやすいフォント、アクセスしやすい目次、人間にとってわかりやすいUrl、バージョン管理のサポート、レスポンシブデザインへの完全な対応を実装します。

・サポート記事の民主化 新しサイトでは、ユーザーのみなさまが記事を執筆および編集できるように、オープンソースのツールや規格を採用します。記事の執筆には、マークダウン形式を使用し、コンテンツ管理システムとしてGitHubを使用します。これにより、誤字脱字などをみなさまに直接訂正していただくことができ、記事の品質が向上します。

・従来の記事の保護 新しいサイトへの移行によって、貴重な従来の記事やコンテンツが失われることがないようにします。2022年末までに、ほぼすべての記事を新しいサイトへと移行させる予定です。

今後のロードマップ

新しいサイトは、WSOFTDocsと名付けられ、2022年秋頃に公開予定です。同年末には、WSOFTの提供するほぼすべての記事が、新しいサイトへと移行されます。