Skip to content

README Feature Weighting

README space should match project importance.

Weighting Rule

  • core identity features get top-level explanation
  • important support systems get short summaries
  • optional or advanced systems get brief mentions plus links
  • experimental, niche, or newly-added systems should not dominate the README unless the project itself has changed identity

Core Identity Features

For ORCA, these usually deserve the most top-level space:

  • setup and getting-started path
  • onboarding and spec-driven workflow
  • execution and coordination flow
  • review, QA, approvals, and inspectability
  • host-aware or tool-aware workflow adaptation at a high level

Support Features

These usually deserve a short summary and a link:

  • background mode
  • goal mode
  • self-improvement systems
  • update systems
  • integrations
  • legacy modernization
  • business ideation

Warning Sign

If a README change makes a reader think ORCA is "mainly about" one secondary subsystem, the weighting is probably wrong.