1.5 KiB
1.5 KiB
English Output Guidelines
This file provides language-specific guidance for generating knowledge graph content in English.
Tag Conventions
Use lowercase, hyphenated tags in English:
| Pattern | Recommended Tags |
|---|---|
| Entry point file | entry-point, barrel, exports |
| Utility functions | utility, helpers, common |
| API handlers | api-handler, controller, endpoint |
| Data models | data-model, entity, schema |
| Test files | test, spec, unit-test |
| Configuration | configuration, build-system, settings |
| Infrastructure | infrastructure, deployment, containerization |
| Documentation | documentation, guide, reference |
Summary Style
Write 1-2 sentence summaries that:
- Describe purpose and role in the project
- Use active voice ("Provides...", "Handles...", "Manages...")
- Avoid restating the filename
Examples:
- Good: "Provides date formatting and string sanitization helpers used across the API layer."
- Bad: "The utils file contains utility functions."
Technical Terms
Keep these terms in English (no translation needed):
middleware,hook,barrel,entry-pointORM,REST API,CI/CD,CRUDsingleton,factory,observermiddleware,interceptor,guard
Layer Names
Use standard English layer names:
API Layer,Service Layer,Data Layer,UI LayerInfrastructure,Configuration,DocumentationUtility Layer,Middleware Layer,Test Layer