shredbx logo
shredbx shredbx shredbx shredbx Personal
  • Home
  • Lab
  • Portfolio
  • Experience
  • Services
  • Profile
  • Contact
AClaude
  • Home
  • Lab
  • Portfolio
  • Experience
  • Services
  • Profile
  • Contact
Andrei Solovev
Knowledge
Search knowledge... ⌘K
Knowledge · Framework · Capabilities

Documentation

Knowledge capture — godoc, JSDoc, usage examples, contract documentation.

Overview

quality

Knowledge capture — godoc, JSDoc, usage examples, contract documentation.

Documentation produces human-readable artifacts that describe system behavior and design intent. In SBX, the model-is-documentation principle means that package.yml, entity descriptors, and capability narratives serve as the primary documentation — not separate markdown files. Generated documentation derives from models, ensuring it never drifts from implementation.

Layer Guidance

PD
Godoc: ValidateEntity validates entity fields
MD
Godoc: Create inserts a new document, returns created record
SI
OpenAPI: POST /api/documents — 201 Created, 400 Error
UI
Storybook: DocumentForm with mock data and error states

Examples

  • Capability descriptor as documentation .framework/protocols/capability-descriptor/
shredbx logo shredbx shredbx shredbx shredbx Andrei Solovev

Solution Architect & Lead Software Engineer

ExperiencePortfolioResearch & ExperimentsEducationCertificationSkills
GitHub ↗LinkedIn ↗Email ↗
AVAILABLE FOR NEW PROJECTS
// MY LATEST BEATS
Hobby & Interests

Lab

  • The Lab
  • Framework
  • Components
  • Packages
  • Games
  • Process (SDLC)
  • Knowledge
  • Blog

Andrei

  • Portfolio
  • Experience
  • Services
  • Profile
  • Contact
  • Lifestyle

Team

  • Team
  • Andrei
  • Claude

Legal

  • Privacy
  • Terms
  • Cookies
© 2026 shredbx.com. All rights reserved. — Andrei Solovev |