OhMySkills
后端服务 django-orm-documentation 更新于 2026-10-19

Django · 文档规则

Documentation rules for Django: decision-level content, tested examples and versioned guides.

技术栈
Django
主题
文档
条目
9 条
版本
v0.2.0

✓ 应当这么做

  • ✓ Document decisions and invariants, not restatements of the code
  • ✓ Keep runnable examples in the docs and test them in CI
  • ✓ Date and version external-facing documents

✕ 常见反模式

  • ✕ Copy-pasted README sections that drift from the code
  • ✕ Docs without an owner
  • ✕ Silently dropping deprecated configuration from the guide

◎ 交付前验证

  • ◎ Type checker (mypy/pyright) passes with zero new suppressions
  • ◎ Tests run in a clean virtual environment
  • ◎ No secrets or environment values read at import time

同分类条目

36 篇

同一技术栈的其他条目