https://github.com/keminghe/common-devx
Ready-to-use templates and AI prompts for consistent documentation, standardized workflows, and faster project setup with zero dependencies
https://github.com/keminghe/common-devx
ai-assisted-development documentation prompt-engineering template
Last synced: 5 months ago
JSON representation
Ready-to-use templates and AI prompts for consistent documentation, standardized workflows, and faster project setup with zero dependencies
- Host: GitHub
- URL: https://github.com/keminghe/common-devx
- Owner: KemingHe
- License: mit
- Created: 2025-07-09T20:42:07.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-12-25T20:25:23.000Z (6 months ago)
- Last Synced: 2026-01-05T11:51:50.511Z (6 months ago)
- Topics: ai-assisted-development, documentation, prompt-engineering, template
- Homepage:
- Size: 71.3 KB
- Stars: 4
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README-template.md
- Contributing: CONTRIBUTING-rebase.md
- License: LICENSE
- Notice: .github/NOTICE.md
Awesome Lists containing this project
README
# README - [DIRECTORY_NAME]
> **Last Updated**: YYYY-MM-DD by [First Name Last Name]
## Overview
[1-2 sentence executive summary: What does this directory contain and why does it exist?]
[Optional status indicator: (Active) | (Legacy) | (Archived) | (In Development)]
## Directory Structure
```text
[directory-name]/
├── [file.ext] # Brief purpose description
├── [subdir1]/ # Brief purpose - See subdir1/README.md for details
├── [subdir2]/ # Brief purpose - See subdir2/README.md for details
└── README.md # This file
```
## Quick Links
- [`../docs/guide.md`](../docs/guide.md) - Related workflow or guide
- [`../other-dir/README.md`](../other-dir/README.md) - Related directory documentation
- [`./subdir/README.md`](./subdir/README.md) - Subdirectory details
## Prerequisites
- **Tool Name** >= version - See [`setup-guide.md`](../docs/setup-guide.md)
- **Access/Credential** required - See [`access-guide.md`](../docs/access-guide.md)
- **Prior Setup** - See [`prerequisite-workflow.md`](../docs/prerequisite-workflow.md)
## Getting Started
1. **Action name**: Brief description
```shell
command-example
```
2. **Action name**: Brief description - See [`detailed-guide.md`](../docs/detailed-guide.md)
3. **Action name**: Brief description
For complete workflows, see:
- [`comprehensive-workflow.md`](../docs/comprehensive-workflow.md)
## References
- [`../related-dir/README.md`](../related-dir/README.md) - Related directory documentation
- [`../docs/decision.md`](../docs/decision.md) - Decision rationale or guide
- [External resource](https://url.com) - When to use this resource
> README Template v1.0.3 - KemingHe/common-devx