SysGit Documentation#
Welcome to the SysGit documentation. This guide will help you get started with SysGit and master its features for distributed requirements management and system modeling.
Getting Started#
New to SysGit? Start here:
- Introduction - Learn about SysGit and Post-Cloud architecture
- Installation and Setup - Get SysGit installed
- Login and Projects - Create your first project
Core Workflows#
Learn the essential features:
- Requirements Management - Create and manage requirements
- Verification Management - Verify your requirements
- Traceability - Establish relationships and coverage
- System Modeling - Build your system architecture
- Design Reviews - Collaborate on designs
Collaboration#
Work effectively with distributed teams:
- Git Workflows - Version control for hardware
- Branching Strategies - Manage parallel development
- Multi-Org Collaboration - Cross-organizational workflows
Advanced Features#
Take your usage to the next level:
- Advanced Authoring - Direct SysML v2 editing
- Search and Filtering - Find what you need
- Reports and Exports - Generate documentation
- AI Features - AI-assisted authoring
CI/CD & Automation#
Automate your workflows:
- CI/CD Overview - Continuous integration for hardware
- Automated Verification - Link to test systems
- Custom Automation - Build custom integrations
Administration#
For IT and system administrators:
- Infrastructure Overview - Deployment architecture
- GitLab Runners - CI/CD infrastructure
- User Management - Authentication and authorization
- Git Provider Integration - GitHub, GitLab, Gitea setup
Reference#
Quick reference materials:
- SysML v2 Language Reference - Complete language guide
- Keyboard Shortcuts - Efficiency tips
- Glossary - Terminology guide
- FAQ - Common questions
- API Reference - Developer documentation
Tutorials#
Hands-on learning:
- Tutorial: First Project - Build a simple drone project
- Tutorial: Multi-Vendor - Complex program management
- Use Case: Aerospace - Aviation development
- Use Case: Defense - Defense systems
Appendices#
Additional information:
- Comparison to Other Tools - DOORS, Jama, Cameo comparison
- Standards Compliance - ISO, DO-178C, MIL-STD
- Release Notes - Version history
- Contributing - Documentation contribution guide
- AI Prompting Guide - Advanced Claude usage
Quick Links#
Most Popular: - Requirements Table - Verification Matrix - SysML v2 Syntax
For Administrators: - Installation Guide - User Management
For Developers: - API Reference - Custom Automation