Skip to content

Commit c6713d7

Browse files
committed
update readme
1 parent 155e833 commit c6713d7

File tree

1 file changed

+29
-2
lines changed

1 file changed

+29
-2
lines changed

README.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,35 @@ npm run lint
5858
現在は本番環境(my-code.utcode.net)はCoolifyでデプロイしています。
5959
Cloudflare Worker のビルドログとステータス表示が見れますが、そちらは使っていません。
6060

61-
## ベースとなるドキュメントの作り方
61+
## ドキュメント
62+
63+
* ドキュメントはセクション(見出し)ごとにわけ、 public/docs/言語id/ページid/並び替え用連番-セクション名.md に置く。
64+
* ページはディレクトリの名前によらず 言語id/index.yml に書かれている順で表示される。
65+
* セクションはセクションIDによらずファイル名順で表示される。
66+
* 各セクションのfrontmatter (各ページ最初のセクション(-intro.md)を除く)
67+
```yml
68+
id: 一意なセクションID。ファイル名・ディレクトリ名と一致していなくても良い。バックエンドがこのセクションIDで識別するので、一度コミットしたら変更不可(ファイル名は何度変えても良い)
69+
title: セクションタイトルと同じものをmd記法を使わずに書いた文字列
70+
level: セクションの見出しレベル(2〜6が使用可)
71+
```
72+
* コード例はそれが配置されているセクションの内容と関連するようにする。コード例だけを独立したセクションに載せるのは避ける
73+
* 良くない例
74+
````md
75+
## 制御構文
76+
### if
77+
if文の説明…
78+
### switch
79+
switch文の説明…
80+
### コード例
81+
ifとswitch共通の注意事項... → ## 制御構文 に移す
82+
```
83+
ifとswitchを使ったコード例… → 2つのコード例に分割する
84+
```
85+
````
86+
* REPLのコード例は1セクションに最大1つまで。
87+
* ページ0以外の各ページの最後はレベル2見出し「この章のまとめ」と、レベル3見出し「練習問題n」を置く
88+
89+
### ベースとなるドキュメントの作り方
6290

6391
- web版の ~~Gemini2.5Pro~~ Gemini3Pro を用いる。
6492
- 以下のプロンプトで章立てを考えさせる
@@ -107,7 +135,6 @@ Cloudflare Worker のビルドログとステータス表示が見れますが
107135
Hello
108136
```
109137
````
110-
- 練習問題の見出しは「この章のまとめ」の直下のレベル3見出しで、 `### 練習問題n` または `### 練習問題n: タイトル` とする
111138
- 練習問題のファイル名は不都合がなければ `practice(章番号)_(問題番号).拡張子` で統一。空でもよいのでファイルコードブロックとexecコードブロックを置く
112139
- 1章にはたぶん練習問題要らない。
113140

0 commit comments

Comments
 (0)