Specvital Documentation

🇰🇷 한국어 버전

Welcome to the Specvital documentation. Specvital is an open-source test coverage insights tool designed to enhance code review processes.

Documentation Structure

PRD (Product Requirements Document)

Product specifications and requirements documentation for the Specvital platform.

• Product Overview - Product vision, target users, and GTM strategy
• Architecture - System architecture and service composition
• Core Engine - Test parser library design
• Web Platform - Web dashboard and REST API
• Collector Service - Background analysis worker
• Database Design - Database schema and design
• Tech Stack - Technology choices and rationale

ADR (Architecture Decision Records)

Documentation of architectural decisions made during the development of Specvital.

Cross-cutting

• ADR Overview - Introduction to architecture decision records
• Static Analysis Approach
• Competitive Differentiation
• API Worker Service Separation
• Queue-Based Async Processing
• Repository Strategy
• PaaS-First Infrastructure
• Shared Infrastructure
• External Repo ID Integrity
• GitHub App Integration
• TestStatus Data Contract

Core

• Core Library Separation
• Dynamic Test Counting Policy
• Tree-sitter AST Parsing Engine
• Early-Return Framework Detection
• Parser Pooling Disabled
• Unified Framework Definition
• Source Abstraction Interface
• Shared Parser Modules
• Config Scope Resolution
• Standard Go Project Layout
• Integration Testing with Golden Snapshots
• Parallel Scanning with Worker Pool
• NaCl SecretBox Encryption
• Indirect Import Alias Detection Unsupported

Collector

• Scheduled Re-collection
• Clean Architecture Layers
• Graceful Shutdown
• OAuth Token Degradation
• Worker-Scheduler Separation
• Semaphore Clone Concurrency
• Repository Pattern

Web

• Go as Backend Language

Tech Radar

Technology adoption status and evaluation criteria across the platform.

Release Notes

Release history for all services (Core, Collector, Web, Infra).

Glossary

Domain terminology used across the platform.

Architecture Overview

High-level system architecture documentation.

Related Repositories

The Specvital platform is composed of multiple repositories:

• specvital/core - Parser engine
• specvital/web - Web platform
• specvital/collector - Worker service
• specvital/infra - Infrastructure and schema

Contributing

This is the main documentation repository for Specvital. For contribution guidelines, please refer to each repository's CONTRIBUTING.md file.

License

See LICENSE for details.