複数人が編集するScrapboxプロジェクトの記述ルール
複数人が編集するScrapboxプロジェクトの記述ルールを決めるとしたら以下のようにするのが良いかも
記述ルール
ルールとは言ってもいい感じになるのScrapboxの使い方を書いているだけです
以下のルールの通りになっていないものは、誰かしらによって編集されるか、下の方に埋もれるかのどちらかになると思います
なので、とりあえず臆せず書いてみるのもいいと思います 誰にとっても完璧というのは誰がやっても無理なので
基本的なルールは5つ
1. 検索や、リンクを辿ってみて書こうとしていることがすでに書かれていないか確認してください
全ては検索から始まります Googleと同じ
辿り着くまでが長かった場合は、次の人がたどりやすくなるようにリンクされているべきページにリンクしてください
2. 文章を書いて説明してリンクしてください
リンクができていて、ちゃんと理解できるものであれば簡素でも大丈夫
リンクできる単語が出てきたからと言って必ずリンクをしなければいけないわけではない
3. 作例などを書く中で、単一のページで特定の手順のやり方が説明されている場合はそれを参照してください
[各四角ポリゴンの縦横比を取得する] をやりますなど
行リンクは非推奨です
参照したい部分がそのページの一部だけである場合はその部分を新しいページに切り出していい感じにリンクしてください
4. 1つのページ内の文章全体がフラットに読めるようにしてください
文字装飾があると読み飛ばす癖がついたり、書き手独自のルールで書いてあるとどういう意図でその装飾をしているかを読み手が考えなければならなくなる
実際↑のインラインコードブロックの部分を一番最初に見てしまった人もいるのではないでしょうか
見出しのように装飾するのは非推奨です
見出しは案外不必要な文字装飾であるか、別のページに切り出し可能な事柄だったりする
ある程度改行するだけで十分なときもある
5. 1つのページのリンクが多すぎる場合はグループ化してください
例えば、[階段]にリンクしてるページが多すぎる時、[螺旋階段]というページを作れば解決するケース
「螺旋階段」のページには[螺旋]上の[階段]と書けば解決するし、「階段」のページに階層化のイメージで[螺旋階段][箱階段][踊り場付き階段]とかを書いておけば辿りやすくなります
逆に、「作例」「Tips」などはそもそもリンクしなくて良い
分割し辛いし、その境界が曖昧になっていくから
数が膨大になってそこから見るということはしないから
ランダムにページを見つけたいのであれば右上のRandomをポチポチ押して面白そうなところからたどる方が良い
それ以外は今のところはルールはないので、例えば以下をやっても構いません
アイデアなどのメモを書く
他の人がそのメモを見ていい感じに実装してもらう、もしくは他により良い解決方法を書いてくれるかも知れません
質問を書く
需要がわかり作例が生まれるか、他に同じことで困った人が同じ検索ワードで辿れるようにするのが目的です
まあ、実現できなかったり、全員めんどくせ~ってなったりしてずーっと未解決なこともあるかもしれません!
単語を書く
階段・パイプなど
検索しやすくするため
例えば手すりだったら「移動時に体のバランスを支えるためのもの [階段]などにある 壁についているものは形状が[パイプ]に似ている」とか書いてあると辿りやすくなるかも
例えば螺旋階段の個別ページを作ったら[螺旋]の[階段]と説明を書いておいたほうが他の「螺旋」や「階段」の事柄とリンクしてたどりやすくなります
別に直接作例のページに[螺旋][階段]って書いててもいい
「螺旋階段」の個別のページが生まれるのは「螺旋階段」もしくは「階段」のリンク数が増えてきたらかな