Back to Skills

business-rule-documentation

KubrickCode
Updated Today
102 views
1
1
View on GitHub
Metawordaiautomationdesign

About

This skill provides standardized templates for systematically documenting business logic and domain knowledge following Domain-Driven Design principles. It helps developers capture business rules, process flows, decision trees, and terminology glossaries to maintain consistency between requirements and implementation. Use it when documenting domain models, creating business rule repositories, or bridging communication between business and technical teams.

Documentation

Business Rule Documentation Guide

Basic Principles

  • Concise and clear
  • With actionable examples
  • Focus on the "why"

Business Logic Documentation

File: docs/domain/{domain-name}.md or the module's README.md

[Domain Name]

Overview

The business area covered by this domain (1-2 sentences)

Core Concepts

[Concept Name]

Definition: Clear definition

Example:

// Actual usage example code

Code Location: src/domain/concept.ts

Business Rules

[Rule Name]

  • Content: Rule description
  • Reason: Why this rule is necessary
  • Exceptions (if any): Exception scenarios
  • Code Location: src/domain/rules.ts:45-67

Process Flow (Complex cases only)

[Process Name]

  1. Step 1 → src/service/step1.ts
  2. Step 2 → src/service/step2.ts
  3. Step 3 → src/service/step3.ts

Cautions (if any)

  • Common mistake areas
  • Things to watch for when making changes

Glossary (if needed)

  • Term 1: Definition
  • Term 2: Definition

Document Management

Document Location

project-root/
├── docs/
│   ├── work/          # Work guidelines (delete after work completion)
│   └── domain/        # Business logic documentation (maintained continuously)
├── WORK_SUMMARY.md    # Work summary report (delete immediately after review)
└── README.md

Lifecycle

  • Work Guidelines: Delete after work completion
  • Work Summary Report: Delete immediately after review
  • Business Logic Documentation: Maintain alongside code

Quick Install

/plugin add https://github.com/KubrickCode/ai-config-toolkit/tree/main/business-rule-documentation

Copy and paste this command in Claude Code to install this skill

GitHub 仓库

KubrickCode/ai-config-toolkit
Path: .claude/skills/business-rule-documentation

Related Skills

llamaguard

Other

LlamaGuard is Meta's 7-8B parameter model for moderating LLM inputs and outputs across six safety categories like violence and hate speech. It offers 94-95% accuracy and can be deployed using vLLM, Hugging Face, or Amazon SageMaker. Use this skill to easily integrate content filtering and safety guardrails into your AI applications.

View skill

sglang

Meta

SGLang is a high-performance LLM serving framework that specializes in fast, structured generation for JSON, regex, and agentic workflows using its RadixAttention prefix caching. It delivers significantly faster inference, especially for tasks with repeated prefixes, making it ideal for complex, structured outputs and multi-turn conversations. Choose SGLang over alternatives like vLLM when you need constrained decoding or are building applications with extensive prefix sharing.

View skill

evaluating-llms-harness

Testing

This Claude Skill runs the lm-evaluation-harness to benchmark LLMs across 60+ standardized academic tasks like MMLU and GSM8K. It's designed for developers to compare model quality, track training progress, or report academic results. The tool supports various backends including HuggingFace and vLLM models.

View skill

langchain

Meta

LangChain is a framework for building LLM applications using agents, chains, and RAG pipelines. It supports multiple LLM providers, offers 500+ integrations, and includes features like tool calling and memory management. Use it for rapid prototyping and deploying production systems like chatbots, autonomous agents, and question-answering services.

View skill