Skip to content

History / Tech Spec Design Reports

Revisions

  • Add ТЗ structure/template to all 14 Tech Spec pages (backend + design) Each page now has the section skeleton to fill in (purpose, functional requirements, API endpoints, DB structure or screens/wireframes, acceptance criteria) instead of just a title stub. Sections in brackets are prompts, not content - teams still write everything specific to their own module themselves. Backend and Design templates differ (DB/API focus vs screens/API-consumer focus) and both point to the API Contract Guide for the shared 4.1 section.

    @claude claude committed Sep 18, 2026
  • Fix broken links, module paths, and add missing referenced pages - Home.md: fixed repo name (was "College_Management_System2131", actual repo is "College_Management_System"). - Getting-Started.md: fixed Issues link (same repo name mismatch), fixed self-referencing broken link (was pointing to a dead "Начало-работы" slug instead of Installation-Setup), updated module folder paths to match the renamed modules/admin_panel, modules/student_portal, modules/teacher_portal (underscores instead of hyphens, since hyphens aren't valid in a Python import path). Documented the new docs/examples/example_module/ reference pattern. - Installation-Setup.md: replaced the placeholder clone URL (your-org/college-management-system) with the real repo URL and correct folder name, removed the mention of PyJWT as an installed dependency (dropped as unused/redundant, see the main repo's latest commits). - Added Git-GitHub-Guide.md, Grading-System.md, FAQ.md as minimal placeholder pages — both Getting Started and Installation Setup already linked to these three pages, but they didn't exist yet. Left as short placeholders (not full guides) since grading policy and git workflow specifics are the instructor's call, not something to fabricate. - Added Tech-Spec-Design-Curriculum.md, Tech-Spec-Design-Reports.md, Tech-Spec-Design-Teacher-portal.md, Tech-Spec-Design-Admin-panel.md, matching the existing minimal one-line style of Tech-Spec-Design-Gradebook/Schedule/Student-portal, so all 7 modules have a page (still just placeholders for teams to fill in via their own ТЗ, not pre-written specs).

    College CMS Fix committed Sep 18, 2026