Skip to content

ドキュメントの meta description を修正(TDD実践)#1797

Merged
yasulab merged 2 commits into
mainfrom
fix-meta-descriptions
Jan 19, 2026
Merged

ドキュメントの meta description を修正(TDD実践)#1797
yasulab merged 2 commits into
mainfrom
fix-meta-descriptions

Conversation

@yasulab
Copy link
Copy Markdown
Member

@yasulab yasulab commented Jan 19, 2026

概要

TDD(Test-Driven Development)を実践し、公開ドキュメントの meta description に HTML タグが含まれている問題を修正しました。

TDD アプローチ

🔴 RED

すべての公開ドキュメントの meta description を検証するテストを追加し、問題のあるファイルを検出:

  • regional-license.md
  • regional-license_en.md
  • post-backend-update-history.md

🟢 GREEN

検出された問題を修正し、テストが通ることを確認:

  • <div> ラッパーを削除し、<img> タグを1行に統一
  • 適切な meta description 用の説明文を追加

🔵 REFACTOR

表記と構造を改善:

  • HELLO WORLD Foundation(CoderDojo Foundation の旧名称)への言及を追加
  • 言語切り替えリンクの位置を改善
  • 説明文の簡潔化

変更内容

テスト追加(spec/models/document_spec.rb

describe 'meta descriptions' do
  it 'すべての公開ドキュメントの meta description に HTML タグが含まれていないこと' do
    # 全ドキュメントをチェックし、HTML タグが含まれている場合はエラー
  end
end

修正したファイル

1. regional-license.md

  • Before: <img> タグが description に(HTMLタグとして認識)
  • After: 「CoderDojo Foundation (当時の名称: HELLO WORLD Foundation) と一般社団法人 CoderDojo Japan の間で締結された地域ライセンス契約書です。2016年の契約当時の写しとなります。」

2. regional-license_en.md

  • Before: <img> タグが description に(HTMLタグとして認識)
  • After: 「Regional license agreement between CoderDojo Foundation and CoderDojo Japan Association, dated August 27th, 2016.」

3. post-backend-update-history.md

  • Before: description が空
  • After: 「2016年の CoderDojo Advent Calendar で公開した、coderdojo.jp のバックエンド刷新に関する技術記事です。」

4. teikan.md

  • 説明文を簡潔化(regional-license との表記を統一)

テスト結果

bundle exec rspec spec/models/document_spec.rb
8 examples, 0 failures ✅

効果

  • ✅ SNS シェア時に適切な meta description が表示される
  • ✅ HTML タグではなく意味のある説明文が表示される
  • ✅ 将来的な meta description の品質を自動テストで保証

スクリーンショット

meta description の例:

  • 日本語版: 「CoderDojo Foundation (当時の名称: HELLO WORLD Foundation) と一般社団法人 CoderDojo Japan の間で締結された地域ライセンス契約書です。」
  • 英語版: 「Regional license agreement between CoderDojo Foundation and CoderDojo Japan Association, dated August 27th, 2016.」

関連 PR

## TDD アプローチ

1. RED: meta description の品質を確認するテストを追加
2. GREEN: 問題のあるファイルを修正してテストを通す
3. REFACTOR: (不要)

## テスト追加

`spec/models/document_spec.rb` に新しいテストを追加:
- すべての公開ドキュメントの meta description に HTML タグが含まれていないことを確認
- 問題のあるファイルを具体的に報告

## 修正したファイル

### regional-license.md
- <div> ラッパーを削除し、<img> タグを1行に統一
- meta description 用の説明文を追加:「CoderDojo Foundation と一般社団法人 CoderDojo Japan の間で締結された地域ライセンス契約書です。2016年の契約当時の写しとなります。」

### regional-license_en.md
- <div> ラッパーを削除し、<img> タグを1行に統一
- meta description 用の説明文を追加:「Regional license agreement between CoderDojo Foundation and CoderDojo Japan Association, dated August 27th, 2016.」

### post-backend-update-history.md
- meta description 用の説明文を追加:「2016年の CoderDojo Advent Calendar で公開した、coderdojo.jp のバックエンド刷新に関する技術記事です。」

## 効果

SNS シェア時に適切な meta description が表示され、
HTML タグではなく意味のある説明文が表示されるようになりました。

## テスト結果

```
bundle exec rspec spec/models/document_spec.rb
8 examples, 0 failures
```
- 言語切り替えリンクを blockquote の後に移動し、より自然な配置に
- 区切り線を追加して、説明部分と契約本文を明確に分離

- 説明文を簡潔化:「現在は改訂されている可能性がある点にご注意ください」→「2016年の設立当時の写しとなります」
- regional-license との表記を統一
@yasulab yasulab merged commit b42a31c into main Jan 19, 2026
5 checks passed
@yasulab yasulab deleted the fix-meta-descriptions branch January 19, 2026 10:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant