Vocabulary
Accepted technical terms for documentation. The Vale linter recognizes these terms and won't trigger spelling errors.
Document Types
ITD, ITDs
Important Technical Decision
Architecture decision records
Spec, Specs
Specification
Project documentation (Teardown, Scope, Build, Feature)
SME
Subject Matter Expert
Domain expert interviews
SLA
Service Level Agreement
Time commitments for deliverables
Platforms & Tools
GitHub
—
Code hosting and collaboration
GitBook
—
Documentation platform with GitHub sync
Pandoc
—
Universal document converter
Mermaid
—
Diagram-as-code tool
Excalidraw
—
Whiteboard diagramming tool
Markdown
—
Lightweight markup language
markdownlint
—
Markdown linting tool
Vale
—
Prose linting tool
Technical Terms
API, APIs
Application Programming Interface
How systems communicate
CLI
Command Line Interface
Terminal-based interface
CI
Continuous Integration
Automated build/test on commit
CD
Continuous Deployment
Automated deployment
PR, PRs
Pull Request
Code review mechanism
repo, repos
Repository
Code storage location
codebase
—
Complete source code of a project
CRUD
Create, Read, Update, Delete
Standard data operations
CUD
Create, Update, Delete
Data modification operations
ERD
Entity Relationship Diagram
Data model visualization
ER
Entity Relationship
Data modeling concept
UUID
Universally Unique Identifier
Unique ID standard
JSON
JavaScript Object Notation
Data serialization format
YAML
YAML Ain't Markup Language
Data serialization format
UI
User Interface
Visual interface
UX
User Experience
Interaction design
async
Asynchronous
Non-blocking operations
OAuth
Open Authorization
Authentication standard
JWT
JSON Web Token
Token-based auth
SDK
Software Development Kit
Developer tools package
LLM
Large Language Model
AI language models
TPM
Technical Product Manager
LostHex role
MVP
Minimum Viable Product
Early product version
PoC
Proof of Concept
Technical feasibility demonstration
SaaS
Software as a Service
Cloud-based software delivery
AWS
Amazon Web Services
Cloud computing platform
SST
Serverless Stack
Infrastructure framework
Company
LostHex
—
Company name
DevFactory
—
Prior employer (spec framework origin)
Last updated