Markdownガイド
チョイタメラボでは、依頼内容や報告、コメント欄で Markdown 形式による装飾が可能です。テキストを構造化して、読みやすく説得力のある検証結果を作成しましょう。
1. 基本的な書式
| 装飾 | 書き方 | プレビュー |
|---|---|---|
| 太字 | **テキスト** | テキスト |
| 斜体 | *テキスト* | テキスト |
~~テキスト~~ | ||
コード | ` SELECT ` | SELECT |
2. 見出し
行頭に # を付けることで見出しになります。
## 検証してほしい内容
### 特定の操作での挙動
#### スマートフォンでの表示
3. リスト
行頭に * または - を入れると箇条書きになります。数字の場合は 1. を使います。
* 検証環境:iPhone 15 / Safari
* 気づいた点
* 読み込みが速い
* フォントが少し小さい
4. コードブロック(重要)
SQL文や実行プランの断片を載せる際に便利です。言語名(sql)を指定するとハイライトされます。
{
"status": "error",
"message": "期待した挙動になりませんでした"
}
5. 引用
他人のコメントや、ドキュメントの一部を引用する際に使用します。
> 1日10件ほどのメモをまとめる機能
この機能について、実際に12件入力してみましたが問題なく動作しました。
6. テーブル
データの比較や、統計情報のサマリーを載せるのに最適です。
| 検証項目 | 期待値 | 実際の結果 |
| :--- | :--- | :--- |
| ログイン速度 | 2秒以内 | 1.2秒 (良好) |
| 画像アップ | 正常終了 | エラー発生 |
7. リンク
[表示テキスト](URL) の形式でリンクを貼ることができます。
例: [MS公式ドキュメント](https://learn.microsoft.com/...)
良い「報告」を書くコツ
- 環境を明記する: OSやブラウザ、試した時間帯などをリスト機能でまとめると、依頼者が再現しやすくなります。
- Before / Afterをテーブルで: 改善案を出す際は、テーブル機能を使って「現状」と「理想」を比較すると伝わりやすくなります。
- チェックリストの活用: 依頼者が提示した「検証してほしい内容」をチェックリストとしてコピー&ペーストし、完了したものからチェックを入れると、漏れのない報告になります。