Briefing

Methodology Framework Summary

Source: docs/briefings/methodology-summary.md · Back to index · Beta hub

Methodology Framework Summary

This briefing condenses the long-form methodology specs so teammates can find the why/what/how without opening six giant Markdown files.

Source set

  • resourcefiles/methodology-framework/stp1.md — Master spec (sections 0–22).
  • resourcefiles/methodology-framework/stp2.md — Same spec with inline comments (useful for TODOs).
  • resourcefiles/methodology-framework/stp3.md — Canonical reference for product language + decisions (consult when writing UI copy).
  • resourcefiles/methodology-framework/stpMvp.md — MVP implementation plan + acceptance checks.
  • resourcefiles/methodology-framework/stpsDecLo.md — Decisions log with timestamps + impacts.
  • resourcefiles/methodology-framework/stpsimplement.md — Implementation scaffolding (routing, component folders).

Key Takeaways

Vocabulary & Roles (stp1/stp2)

  • Objects: Resource, Signal, Block, Annotation (V2), Collection, Group.
  • Roles: Guest (view limited content), Participant (create own Signals, propose Resources, default Group-only visibility), Editor (TA/Admin, global curation, can widen visibility).
  • Privacy: Private → Group-only → Members → Public (MVP excludes Participant-created Public). Child visibility always ≤ parent.

Collections vs Sessions (stpsDecLo)

  • DEC-001: Collection = bucket (Week/Theme). Session = event/agenda. Agenda = ordered list inside Session. Calendar/Timeline are views over Sessions.

Signal & Resource Model (stp1/stpMvp)

  • Signals: Title ≤100 chars, Context, Block stack (Text/Link/Image/Video/File/Quote/Checklist), Domain facet, Stakeholders facet, Reactions (👍 ❓ ⭐).
  • Resources: Title, Type, URL/File, Source, Author(s), Domain tags, Week links, Estimated Time, badges (Assigned/Supplemental/New/etc).
  • Validation: At least one block; link/image/file constraints; AI nudges only for duplicates/citations in MVP.

Discussions & Posts (stpsDecLo, stpMvp)

  • Signals remain analytical. Posts (Question/Reflection/Submission) live under Discussions (global/week/session). Replies depth = 1. Inline block comments stay tied to Signals.

MVP Scope (stpMvp)

  • In: Library, Collections, Signal composer/detail, Resource composer/detail, Session agenda, Discussions, privacy enforcement, moderation flags, nudged AI.
  • Out: Teacher-only actions, Participant Public posts, annotations, advanced analytics, exports, i18n.

Implementation Skeleton (stpsimplement)

  • Route map under apps/stps/app/ with explicit page purposes (Library, Collection detail, Signal composer/detail, Resource composer/detail, Session agenda, Discussions).
  • Component folders: cards/, blocks/, filters/, session/, discussions/.
  • lib/ split into convex/, api/, auth/, ui/; shared styles define muted per-Domain hues.

Decisions to Remember (stpsDecLo/stp3)

  • Layered tags: Domain facet is MVP; Stakeholders allow ≤5 chips; Scale/Urgency nudged.
  • Storage-agnostic model (Convex nodes + Supabase auth/files) so we can swap providers later.
  • Provider abstraction: AuthProvider, FileStore, Persistence set now to avoid churn.
  • Seeds: Each core entity gets 3–5 professional examples for demo quality.
  • Router freeze: stay on current Next.js router for Phase 0; no Pages/App Router flip.
  • Public posting by Participants deferred; Editors can set Public when copyright allows.

Where to look next

  • Need detailed copy or field lists? open stp3.md.
  • Want to know if something is MVP vs deferred? check stpMvp.md + DEC log.
  • Building routes/components? mirror stpsimplement.md.

How to Use This Summary

  • Design/PM: Grab terminology + role policies here before drafting new pages.
  • Engineering: Follow stpsimplement for directories, stpMvp for “in vs out,” and stpsDecLo for settled decisions.
  • Docs: Link to this file from Hub/Beta Explainer as the non-dev crib sheet.