code-documentation
FeaturedWriting effective code documentation - API docs, README files, inline comments, and technical guides. Use for documenting codebases, APIs, or writing developer guides.
Data & Documents 1,160 stars
137 forks Updated 1 months ago MIT
Install
Quality Score: 94/100
Stars 20%
Recency 20%
Frontmatter 20%
Documentation 15%
Issue Health 10%
License 10%
Description 5%
Skill Content
# Code Documentation
## README Structure
### Standard README Template
```markdown
# Project Name
Brief description of what this project does.
## Quick Start
\`\`\`bash
npm install
npm run dev
\`\`\`
## Installation
Detailed installation instructions...
## Usage
\`\`\`typescript
import { something } from 'project';
// Example usage
const result = something.doThing();
\`\`\`
## API Reference
### `functionName(param: Type): ReturnType`
Description of what the function does.
**Parameters:**
- `param` - Description of parameter
**Returns:** Description of return value
**Example:**
\`\`\`typescript
const result = functionName('value');
\`\`\`
## Configuration
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| `option1` | `string` | `'default'` | What it does |
## Contributing
How to contribute...
## License
MIT
```
## API Documentation
### JSDoc/TSDoc Style
```typescript
/**
* Creates a new user account.
*
* @param userData - The user data for account creation
* @param options - Optional configuration
* @returns The created user object
* @throws {ValidationError} If email is invalid
* @example
* ```ts
* const user = await createUser({
* email: 'user@example.com',
* name: 'John'
* });
* ```
*/
async function createUser(
userData: UserInput,
options?: CreateOptions
): Promise<User> {
// Implementation
}
/**
* Configuration options for the API client.
*/
interface ClientConfig {
/** The API base UR...
Details
- Author
- MoizIbnYousaf
- Repository
- MoizIbnYousaf/Ai-Agent-Skills
- Created
- 11 months ago
- Last Updated
- 1 months ago
- Language
- JavaScript
- License
- MIT
Integrates with
Similar Skills
Semantically similar based on skill content — not just same category
Data & Documents Listed
documentation-templates
Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation.
487 Updated today
aiskillstore Data & Documents Featured
documentation-templates
Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation.
33,961 Updated today
davila7 Data & Documents Featured
documentation-templates
Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation.
49,938 Updated today
sickn33