Skip to content

Latest commit

 

History

History
100 lines (84 loc) · 8.77 KB

README.md

File metadata and controls

100 lines (84 loc) · 8.77 KB

Molibot Docs

This directory is organized by document purpose first, then by topic. Start with the feature overview when you want to understand what Molibot can do today.

docs/agent-dev-series/ and docs/superpowers/ are maintained as standalone collections and keep their existing internal structure.

Archived material lives under archive/: quarterly root-record archives (prd-archive-YYYY-QN.md, features-archive-YYYY-QN.md, changelog-YYYY-QN.md) plus subdirectories for superseded/delivered standalone documents (archive/requirements/, archive/designs/, archive/guides/). Archived content is frozen history, not authority for current behavior.

Directory map

Directory Use for
features/ User-facing capability explanations, starting points, and current boundaries.
guides/ Operator and developer guides for using, configuring, deploying, and extending Molibot.
requirements/ Planned product scope, MVP boundaries, and acceptance-oriented requirements.
adr/ Accepted architecture decisions and the reasoning behind them, for decisions that outlive any one feature.
designs/ Durable architecture, technical designs, and system proposals.
research/ External research, market notes, competitor analysis, and background investigation.
reviews/ Durable technical review conclusions and post-analysis reports.
work/ Time-bound implementation plans, handoffs, progress trackers, implementation-linked reviews, and audit evidence. Not a stable product-documentation entrypoint.
reference/ Raw provider documentation, prompt captures, API examples, and other source material.
articles/ Long-form publishable articles and drafts.
images/ Shared diagrams and image assets.
archive/ Historical changelog, feature, and PRD records.
agent-dev-series/ Agent development article series.
superpowers/ Superpowers planning, specification, and review documents.

开发与界面规范

  • 开发与验证指南:实现、修复、持久化、定向验证与记录维护。
  • 设计规范:视觉与交互核心约定,含主题、布局、动效和页面专项入口。
  • Pitfalls:按模块分类的事故索引与完整复盘。

Common entrypoints

Features

Planned and requirements

Architecture and operation

Filing rules

  • Put new stable documentation in the directory that matches its current purpose, not only its feature area.
  • Put explanations of shipped, user-visible behavior in features/; link from those pages to relevant guides and durable designs.
  • Put time-bound execution plans, handoffs, progress trackers, screenshot audits, and implementation-linked review material in work/.
  • If a process document becomes a durable decision, extract or move the durable conclusion to requirements/, designs/, reviews/, or features.md; do not make work/ a dependency for normal use.
  • If a document changes purpose, move it instead of duplicating it.
  • Keep raw API examples and copied prompt/provider material under reference/.
  • Keep publishable prose under articles/.
  • Keep the repository's domain glossary under reference/CONTEXT.md.
  • Keep the current capability status only in requirements/personal-assistant-capability-matrix.md; plan/PRD/design documents under requirements/ and designs/ must stay current with shipped reality or be archived via the doc-lifecycle rules.