Skip to content

初期コンテンツ作成のお手伝い方法

Jump to bottom
kayhide edited this page Apr 5, 2017 · 18 revisions
  1. 初期コンテンツリストから項目を選ぶ。
  2. コンテンツをガイドラインに沿って作成する。
  3. 作成したらリストの項目をチェックする。
  4. 1 に戻る。

ガイドライン

初期コンテンツにおいては、作成しやすさを優先するためシンプルに以下の方針で進めます。

  • 内容の吟味は後回しにします。
    • 自分の視点でコンテンツを書いて OK です。
  • 作成編集時にはイシューやプルリクは不要です。
    • master に直接プッシュしてください。
    • ですので、github のブラウザエディタでも編集できます :octocat:📝
    • コミットログにイシューのナンバーを書いておくと逆リンクされて便利です。
  • 誰かが作成した既存のコンテンツも編集して構いません。
    • 追加の情報、別のやり方など気軽に投入してください。
    • タイポや表記ミスなど簡単なものは、気付いたらそっと直してあげてください。

以下、🚀 は初期コンテンツ作成限定の方針です。

🚀 コンフリクトしてしまったら:collision:

  • 前のものを消さずに追記、併記するなどしてください。
  • 対応が難しい場合はとりあえず末尾に追記して、リストのイシューにその旨をコメントしてください。

もし、コンテンツが長くなりすぎてしまったら:snake:

  • 🚀 あとで調整しますので、リストのイシューにその旨をコメントしてください。
  • 🚀 内容を切り詰めて減らす必要はありません。
  • 目安として PC のブラウザでみて 3 スクロールを越えるものは長すぎとします。

逆に短すぎということはあるの？

  • 下限の目安はありません。
  • 執筆者が目的が達成できると判断した量でよいです。
  • また他の人が見たときに不十分だと判断したら、その人が追記する方針でいきます。

main 関数は書いたほうがいいの？（調整中）

  • その方がスタンドアローンなコードにできるんだけど？
  • IO が関係する場合はあった方がいいかも？
  • IO 無関係な場合はどうなのかな？

🚀 ちなみに初期コンテンツリストってどうやって作ったの？

  • 某スクリプト言語のレシピ集を参考にしています。
  • 項目ひとつひとつを検討はしましたが、まだ的外れな項目や分割統合した方がよい項目などがあるかもしれません 🙇
  • 項目自体に疑問や提案などがある場合は、リストのイシューにコメントしてください 🙇‍♀️

コンテンツのフォーマットは？

ファイル名はどうするの？

  • ファイル名は コンテンツのタイトル.md とします。

タイトルの命名に規則が必要なのでは？

  • タイトルは動詞で終わる表現に統一します。
  • タイトルには半角記号は使わないようにします。
  • 必要ならば適宜表現を変えて表記します。
    • ❌ 正規表現の「.」に\nをマッチさせる
    • ⭕️ 正規表現のドットに改行をマッチさせる
    • ❌ リストを「,」区切りで連結して文字列にする
    • ⭕️ リストをカンマ区切りで連結して文字列にする

タイトルはコンテンツにいれる？

  • コンテンツの一行目に h1 でタイトルを書きます。

    # リストを作成する

リストを作成するには・・・

コンテンツの分量はどの程度にするのがよい？

  • 内容の分量は 3 スクロール以内で表示できる程度にします。
  • それ以上必要な場合は項目を分けます。

コードを書くには？

  • コードは haskell のコードブロックで書きます。

返り値を表示したいんだけど？

  • 返り値を表示する場合は、次の行にコメントで書きます。

    ```haskell
replicate 3 "hoge"
-- ["hoge","hoge","hoge"]
```

    replicate 3 "hoge"
-- ["hoge","hoge","hoge"]

  • 無限リストを表示する場合は、最初の要素をいくつか表示したあと ,... と書きます。

    ```haskell
repeat "piyo"
-- ["piyo","piyo","piyo",...]
```

    repeat "piyo"
-- ["piyo","piyo","piyo",...]

標準出力を表示したいのだけど？

  • 次の行にコメントで書きます。

    ```haskell
main = do
  print "ほげ"
  -- "\12411\12370"
  putStrLn "ほげ"
  -- ほげ
```

    main = do
  print "ほげ"
  -- "\12411\12370"
  putStrLn "ほげ"
  -- ほげ

パッケージを使うときは？

  • パッケージを利用する際は、import の前の行にパッケージ名をコメントで書きます。

    ```haskell
-- containers
import qualified Data.Map as Map
import qualified Data.Set as Set
```

    -- containers
import qualified Data.Map as Map
import qualified Data.Set as Set

型とかパッケージの一覧とかあったらよくない？

  • 大項目（文字列や数値など）において共通するトピックは、README.md に書きます。
  • 関連する型の概要や、よく使うパッケージの情報などを書くとよいでしょう。
Clone this wiki locally