技術仕様書・設計書

課題

プロダクト開発に欠かせないのが技術仕様書です。 ドキュメントを書いたはいいものの、GitHubやWikiなどいろんな場所に散らばってしまって見つけにくい…… 使っているサービスによって画像がアップロードできない…… など、歯がゆい思いをしている開発者の方は少なくないのではないでしょうか？

施策

技術仕様書もDocBaseにまとめましょう

DocBaseでは技術ドキュメントを書くためのさまざまな機能を揃えています。

・ Markdown記法に対応
・Mermaid.js, PlantUMLなどの技術者向けサービスの埋め込みに対応
・LaTeXの数式に対応

Markdown記法に対応

エンジニアフレンドリーなMarkdown記法に対応しています。 また編集画面にはMarkdownヘルパーがあり、書くのが面倒なテーブルやチェックボックスはクリックひとつで簡単に作成できます。

DocBaseのMarkdownヘルパー

Mermaid.js, PlantUMLなどの技術者向けサービスの埋め込みに対応

Mermaid.js, PlantUMLなど、ER図やシーケンス図を書くのに便利なツールをDocBase上で直接記述することができます。別サービスで作成したものをiframeで埋め込む必要はありません。

LaTeXの数式に対応

また、LaTeXの数式もDocBase上で直接記述できます。理系の研究室の方にもってこいです。

メモを差し込んでまとめメモに

DocBaseの機能のひとつに差し込みメモがあります。 細かい単位でメモを書いておいて、ひとつのメモに差し込むことで簡単にまとめメモを作成できます。 例えばヘルプセンターのDocBase APIドキュメントのメモでは、ひとつのAPIごとに仕様のメモを作り、まとめメモに差し込んでいます。

細かいトピックは差し込みメモにすることで省スペースになりますし、細かい単位でメモを書いていくので、心理的なハードルも下がります。

技術仕様書をDocBaseに書くメリット

DocBaseで技術仕様書を書くメリットがもう1つあります。 技術仕様書も、そうでないドキュメントもすべてDocBaseに書くことで、チーム内のすべての情報をDocBaseに集約できるのです。 日報はこのツール、技術仕様書はこのツール…… と、情報の性質ごとにバラバラのツールを使うのは健全な状態ではありません。DocBaseにすべての情報を書いておけば、ドキュメント探しの時間を大幅に短縮できます！