SpecDown

ドキュメント & フォルダ

ドキュメントとフォルダを使って仕様を論理的な階層に整理しましょう。

ドキュメントの作成

新規ドキュメントを作成するには:

  1. ファイルツリーでNew Documentボタン(+アイコン)をクリックするか、フォルダを右クリック。
  2. タイトルを入力。SpecDownがタイトルからスラッグを自動生成。
  3. Createをクリック。ドキュメントがすぐにエディターで開きます。

CLI経由:

specdown new "Authentication Guide"
# フォルダ内:
specdown new "OAuth Flow" --parent guides

フォルダの作成

フォルダはコンテナ — 他のドキュメントとフォルダを保持しますが、自身のMarkdownコンテンツはありません。

フォルダを作成するには、ファイルツリーヘッダーのフォルダ+アイコンをクリックするか、CLIを使用:

specdown new "API Reference" --folder
ネスト: フォルダは任意の深さまでネストできます。一般的な構造:
📁 guides/
  📁 api/
    📄 authentication
    📄 endpoints
  📁 tutorials/
    📄 getting-started
📄 changelog

並べ替え

ファイルツリーでドキュメントとフォルダをドラッグ&ドロップして並べ替え。順序はsort_orderフィールドに保存され、共有ビューに反映されます。

フォルダ内では、並び順は:フォルダが先、次にsort_order、 その後アルファベット順。

名前変更

ファイルツリーでドキュメントまたはフォルダ名をダブルクリックしてインラインで名前変更します。 名前変更はすべての種類で動作します — Markdown ドキュメント、HTML ドキュメント、フォルダ。

拡張子は自動的に保持されます。 my-page.html landing に名前変更すると landing.html になります — .html を再入力する必要はありません。ファイルの種類を変更する場合(まれ)は、新しい名前に拡張子を含めてください。例: landing.md

フォルダの名前を変更すると、すべての子孫のパスプレフィックスが同じ操作で更新されるため、 プロジェクト内のリンクは追加の編集なしで解決され続けます。

注意: 名前変更によってドキュメントのスラッグが変わります — 古いスラッグに紐付いた既存の 共有リンクや Git 同期パスは壊れます。名前変更後に別途更新してください。

ドキュメントの削除

SpecDownはソフトデリートを使用 — 削除するとdeleted_atタイムスタンプが 設定され、完全には削除されません。誤削除からデータを保護します。

削除するには:

  • ファイルツリーでドキュメントを右クリック → Delete
  • CLI経由:specdown rm guides/api/authentication
削除したドキュメントは現在UIから復元できません。復元が必要な場合はサポートにお問い合わせください。

プロジェクト添付ファイル

ドキュメントとフォルダに加えて、ファイルツリーには project attachment も表示できます。 これは Markdown 以外のファイルで、project 内に独自の path を持ち、preview モードで開きます。

  • ファイルツリーヘッダーの upload ボタンからファイルまたはフォルダを取り込みます
  • .md.html.htm は編集可能なドキュメントになります
  • PDF、画像、動画、CSV、その他のコード/テキストファイルは attachment になります
  • attachment は同じ tree に表示され、Markdown から [@/path/to/file] で参照できます

ドキュメント制限

プランプロジェクトあたりドキュメント数プロジェクト数
Free101
Pro無制限5
Team無制限無制限

始める準備はできていますか?

コードのようにSpecを書く。Gitと同期する。チームと共有する。