wiki運用について - hide003184/pubtest-dev GitHub Wiki

方針・ルール・手順・Tips・設定情報 等をWikiにまとめます。

最初から完璧な運用ルールを作るには大変な労力が掛かるので、まずは、「決まったこと」を記載して、少しずつ運用ルールを充実させましょう!

※あくまで便利ツールなので、誰でも参照、編集ができます。

Wikiの目的

  1. 開発者向けのナレッジ共有に用いる。

  2. 開発作業におけるチームで取り決めた方針・ルールの明文化。

  3. 開発者が実施する各種作業の手順の管理。

Wikiの記述ルール

新しい記事を作成した場合

  • カスタムサイドバーを編集し、その記事へのリンクを適切なツリー位置に配置する。

文書タイトルを変更した場合

  • カスタムサイドバーを編集し、その記事へのリンクを変更する。

  • 文書タイトルはそのままリンクURLになるため、他の文書からリンクされている場合は変更に注意すること。 (不用意に変更しないこと)

カスタムサイドバーの編集ルール

  • 未完成の文書リンクの表示名の末尾に "*" を付与する。(文書本体のタイトルは編集しない)

記述例

テスト記事*