project-checklist

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

project-checklist

project-checklist

  • 各項目は、現状を確認し、充足条件と比較して判定する
  • 判定には、確認した場所と結果を添える
  • 判定は「充足」「不足」「未確認」「対象外」のいずれかにする
  • 判定の作業中は修正しない。不足は一覧として渡す。修正しながら判定すると、判定が修正の結果に置き換わる
  • For each item, confirm the current state and assess it against its acceptance criteria
  • Include the location checked and the result in the assessment
  • The assessment must be one of “Satisfied”, “Missing”, “Not Verified”, or “Not Applicable”
  • Do not make fixes while assessing. Provide a list of missing items instead. Fixing issues while assessing replaces the assessment with the result of those fixes

この skill が必要な理由と達成したい状態

Why this skill is needed and the state it aims to achieve

この skill が必要な理由は、設計で検討すべき事項の多くが、検討しなくてもプロジェクトが動いてしまうことにある。誰も決めなければデフォルトがそのまま答えになり、ビルドもテストも通るので、決めていないことに気づかない。問題は、公開した後に請求や情報漏えいとして見つかる。
この skill で達成したい状態は、設計で検討すべきすべての事項について、プロジェクトの現状を実物の根拠つきで説明できることである。
The reason this skill is needed is that many matters that should be considered during design can remain undecided without preventing the project from running. If nobody makes a decision, the defaults become the answer, and both the build and the tests pass, making it easy to remain unaware that no decision was made. Problems may only surface after publication as unexpected charges or information leaks.
The state this skill aims to achieve is the ability to explain the current state of every matter that should be considered during project design, with evidence from the actual implementation.

判定の方法

Assessment method

  • 現状は、本番環境、ビルドの出力、リポジトリのファイルの順に確認する。本番に近いものほど、意図ではなく事実を表すからである。本番での確認方法は measure-dont-guess に従う
  • 方針や設定が書いてあるだけでは「充足」にしない。書いてあっても機能していないことがある
  • 数値で決まる項目は、計測した数値で判定する
  • 対象プロジェクトの AGENTS.md や CLAUDE.md に決まりがあれば、それを充足条件にする。そのプロジェクトで下した判断が一般的な基準より優先するからである
  • 確認できなかった項目は「未確認」とし、確認できなかった理由を書く。推測で埋めると、確認していない内容が確認済みの内容と区別できなくなる
  • 当てはまらない項目は「対象外」とし、プロジェクトの実物から言える理由を書く。理由を書けない対象外は不足として扱う
  • 検査や lint を緩めて通した形跡は、それ自体を不足として扱う。タスクの削除、severity や ignorePatterns の緩和、抑止コメントの増加がこれにあたる。緩んでいるかもしれない検査は、ほかの判定の根拠に使えないからである
  • Check the current state in this order: the production environment, build output, and repository files. The closer an environment is to production, the more it reflects facts rather than intent. Use measure-dont-guess for checks in production
  • A policy or setting that is merely documented is not enough to mark an item as “Satisfied”. Even when documented, it may not work
  • For items defined by numerical criteria, assess them using the measured values
  • If the target project has decisions defined in AGENTS.md or CLAUDE.md, use those as the acceptance criteria. Decisions made for that project take priority over general standards
  • Mark items that could not be checked as “Not Verified” and state the reason. Filling gaps with speculation makes unverified information indistinguishable from verified information
  • Mark items that do not apply as “Not Applicable” and state the reason based on the actual project. An item marked “Not Applicable” without a reason is treated as missing
  • Treat signs that checks or lint rules were relaxed merely to make them pass as missing items themselves. This includes deleted tasks, relaxed severity or ignorePatterns settings, and increased suppression comments. Potentially relaxed checks cannot be used as evidence for other assessments

項目

Items

次もすべて読むこと。
  • requirements
    。利用者と目的、想定する規模
  • access
    。ページと API ごとの公開範囲と、認証と認可
  • rendering
    。ページごとのレンダリング方式
  • data
    。データの保存先、スキーマの変更手順、キャッシュ
  • security
    。シークレット、依存パッケージの脆弱性、レスポンスヘッダー、動的スキャン、レート制限
  • cost
    。1 回のアクセスで発生する課金、暴走時の上限、実際の請求額
  • performance
    。Web Vitals とサーバーの応答時間
  • search-and-sharing
    。検索エンジンへの掲載、掲載ページの内容、SNS で共有したときの表示
  • accessibility
    。自動検査で見つかる違反と、キーボード操作
  • observability
    。本番リクエストの追跡、計測、障害の検知
  • reliability
    。データの復旧、リソースの再作成、外部呼び出しの失敗
  • delivery
    。CI とデプロイの経路、ロールバック、環境変数
  • dependencies
    。依存パッケージの選定とライセンス、第三者の素材、Node.js のバージョン
  • privacy
    。収集している個人情報と、その削除
  • publishing
    。公開しているものの一覧、URL の変更、撤去手順
masseater/typescript-template から作ったリポジトリでは、次も読むこと。
  • typescript-template
    。テンプレートの骨格が導入され、機能し、旧構成が残っていないか
Read all of the following as well.
  • requirements
    . Users and objectives, expected scale
  • access
    . Public scope for each page and API, authentication, and authorization
  • rendering
    . Rendering method for each page
  • data
    . Data storage locations, schema change procedures, and caching
  • security
    . Secrets, dependency vulnerabilities, response headers, dynamic scanning, and rate limiting
  • cost
    . Charges per access, limits during runaway usage, and actual billing amounts
  • performance
    . Web Vitals and server response times
  • search-and-sharing
    . Search engine indexing, indexed page content, and display when shared on social media
  • accessibility
    . Violations detected by automated inspections and keyboard operation
  • observability
    . Tracing, measurement, and incident detection for production requests
  • reliability
    . Data recovery, resource recreation, and external call failures
  • delivery
    . CI and deployment paths, rollbacks, and environment variables
  • dependencies
    . Dependency selection and licenses, third-party assets, and the Node.js version
  • privacy
    . Personal information being collected and how it is deleted
  • publishing
    . List of published items, URL changes, and removal procedures
For repositories created from masseater/typescript-template, read the following as well.
  • typescript-template
    . Whether the template structure has been introduced, works correctly, and has left no remnants of the previous configuration

用途

Use cases

次を読むこと。
  • check
    。プロジェクトの現状を確認して判定する
  • setup
    。テンプレートから作ったリポジトリの GitHub 側の設定を gh で揃える
Read the following as well.
  • check
    . Inspect the current state of the project and assess it
  • setup
    . Configure the GitHub-side settings of repositories created from the template using gh