engineering-docs Plugin

Was ist in engineering-docs enthalten

28 Teile wurden aus den eigenen Dateien des Plugins gelesen.

Skills in engineering-docs

1. 
   admin-access-control-specificationfattain-naime/engineering-docs

   Specify admin roles, permissions, and every admin-facing control in a system - a full role-permission matrix (RBAC), the principle of least privilege applied concretely, admin action audit logging, and emergency/break-glass access procedures. Use whenever a system has more than one privilege level, before building the admin panel or access-control logic.

   2 Dateien
   6Stars
2. 
   api-design-documentfattain-naime/engineering-docs

   Design a production-ready API specification aligned with OpenAPI 3.1 standards. Covers resource modeling, endpoint design, request/response contracts, authentication, versioning strategy, error handling, rate limiting, and pagination. Use when designing a new REST, GraphQL, or event-driven API.

   2 Dateien
   6Stars
3. 
   architecture-decision-recordfattain-naime/engineering-docs

   Create a standalone Architecture Decision Record (ADR) for a single significant architectural decision. Captures context, decision, alternatives considered, and consequences. ADRs are immutable - once accepted, they are never edited, only superseded by a new ADR.

   2 Dateien
   6Stars
4. 
   business-conceptfattain-naime/engineering-docs

   Turn a raw business idea into a complete business concept document. Covers problem, target users, value proposition, monetization, scope, timeline, and constraints. Use as the first step before any technical documentation.

   2 Dateien
   6Stars
5. 
   database-design-documentfattain-naime/engineering-docs

   Design a production database schema including ERD, table definitions, data dictionary, indexing strategy, normalization decisions, and migration plan. Use when designing a new database, adding major entities, or documenting an existing schema.

   2 Dateien
   6Stars
6. 
   deployment-planfattain-naime/engineering-docs

   Write a production deployment plan covering environment specs, deployment strategy (Blue-Green, Canary, Rolling, or Direct), step-by-step execution runsheet, go/no-go criteria, monitoring plan, and rollback procedure. Use before any non-trivial production release.

   2 Dateien
   6Stars
7. 
   design-system-specificationfattain-naime/engineering-docs

   Design a production-ready Design System and UI/UX visual style guide. Covers design tokens (colors, typography, spacing, shadows, radius), components (buttons, inputs, cards, tables, modals, navigation), layouts, interaction/hover states, iconography, motion design, responsive behavior, accessibility (WCAG 2.2), and dark/light mode rules. Use when starting a new website/app design or standardizing existing branding.

   2 Dateien
   6Stars
8. 
   disaster-recovery-planfattain-naime/engineering-docs

   Write a disaster recovery and business continuity plan defining RTO/RPO targets, backup and failover procedures, DR tiers, and a recovery drill cadence for surviving major infrastructure loss, data corruption, ransomware, or regional outages. Use before launch of any system holding critical or financial data, or to formalize continuity commitments for compliance (PCI-DSS, SOC 2, ISO 22301).

   2 Dateien
   6Stars
9. 
   implementation-planfattain-naime/engineering-docs

   Create a phased implementation roadmap that sequences the technical build of an entire project - build order, module dependencies, environment/tooling setup, per-phase Definition of Ready/Done, and integration checkpoints. Use after the project plan and architecture exist, to turn "what we're building and when" into "in what technical order we actually build it."

   2 Dateien
   6Stars
10. 
    incident-postmortemfattain-naime/engineering-docs

    Write a blameless post-incident review (post-mortem / RCA) that documents what happened, the timeline, root cause analysis, impact assessment, and concrete action items to prevent recurrence. Follows Google SRE blameless post-mortem culture.

    2 Dateien
    6Stars
11. 
    project-planfattain-naime/engineering-docs

    Create a project delivery plan covering scope, milestones, timeline, work breakdown, resourcing, stakeholder roles (RACI), dependencies, budget, quality gates, and a project-level risk register. Use at the start of any project to define who is building what, in what order, by when - before any code is written.

    2 Dateien
    6Stars
12. 
    security-threat-modelfattain-naime/engineering-docs

    Produce a structured security threat model using the STRIDE framework, identify trust boundaries, enumerate attack vectors, assess risk, and define concrete mitigations. Use when reviewing security of a new feature, system, or integration.

    2 Dateien
    6Stars
13. 
    slo-error-budget-documentfattain-naime/engineering-docs

    Define Service Level Indicators (SLIs), Service Level Objectives (SLOs), and error budgets for a service, including multi-window multi-burn-rate alerting and an error budget policy. Use when establishing reliability targets, negotiating an external SLA, or deciding how much risk a team can spend on shipping velocity versus reliability work.

    2 Dateien
    6Stars
14. 
    system-architecture-documentfattain-naime/engineering-docs

    Create a System Architecture Document (SAD) with C4 model diagrams, 4+1 view decomposition, integration maps, NFR constraints, and an Architecture Decision Record log. Use when documenting how an entire system or major subsystem is structured.

    3 Dateien
    6Stars
15. 
    technical-blueprintfattain-naime/engineering-docs

    Write a Technical Design Document (TDD) / Software Design Document (SDD) that details how a specific feature or component will be built. Covers problem statement, proposed design, data model, API contracts, alternatives considered, security threat analysis, test plan, and rollback plan. Use when an engineer or team needs to align on the implementation approach before writing code.

    2 Dateien
    6Stars
16. 
    technical-feasibility-studyfattain-naime/engineering-docs

    Assess whether a proposed technical solution is viable given the current stack, team, timeline, and constraints. Produces a go/no-go recommendation with evidence. Use before committing engineering resources to design or implementation.

    2 Dateien
    6Stars
17. 
    technical-runbookfattain-naime/engineering-docs

    Write a production operations runbook that provides on-call engineers with step-by-step procedures for operating, monitoring, and recovering a system. Covers system overview, alert response procedures, common failure modes, diagnostic commands, escalation paths, and maintenance procedures. Modeled on Google SRE runbook standards.

    2 Dateien
    6Stars
18. 
    technical-specificationfattain-naime/engineering-docs

    Write a technical specification (SRS/TSD) that captures stakeholder needs, system requirements, functional behavior, non-functional constraints, and acceptance criteria. Use when starting any significant engineering initiative.

    2 Dateien
    6Stars
19. 
    test-strategy-documentfattain-naime/engineering-docs

    Create a production-ready Testing Strategy and QA Execution Plan. Covers testing levels (unit, integration, E2E, performance), mocking boundaries, test environment matrix, code coverage thresholds, and automated CI pipeline runsheets. Use when establishing a QA framework for a new system or feature set.

    2 Dateien
    6Stars
20. 
    user-personas-behaviorfattain-naime/engineering-docs

    Define who a product is for, what they're trying to accomplish, how success is measured, and what to instrument to know if it's working. Covers user personas (goal- and behavior-based, not demographic), jobs-to-be-done, success metrics/KPIs, and an analytics/event-tracking plan. Use before or alongside requirements gathering so "who is this for and how do we know it's working" is answered explicitly.

    2 Dateien
    6Stars
21. 
    using-engineering-docsfattain-naime/engineering-docs

    The entry point for this plugin. Give it a raw project idea or concept and it takes over: runs a discovery conversation, decides which document skills apply and in what order, then generates that full document set one skill at a time. Use when you have an idea and don't yet know which documents you need.

    3 Dateien
    6Stars
22. 
    ux-flow-specificationfattain-naime/engineering-docs

    Document the complete user experience of a product - information architecture, user journeys, screen-by-screen flows, and every UI state (loading, empty, error, success) - independent of visual styling. Use to define exactly how a user moves through a product before or alongside implementation, so navigation and edge-case behavior are decided upfront rather than improvised.

    2 Dateien
    6Stars