| name | Technical Documentation |
| description | This skill should be used when the user asks to "write documentation", "create README", "API docs", "design document", "specification", "user guide", or needs documentation guidance. Provides comprehensive documentation patterns for developers, teams, and end-users in both English and Japanese. |
| version | 0.1.0 |
[
Brief one-line description of what the project does.
- Feature 1
- Feature 2
- Feature 3
npm install package-name
import { example } from "package-name";
const result = example();
console.log(result);
See full documentation for detailed guides.
Contributions welcome! See CONTRIBUTING.md.
MIT
All requests require an API key in the Authorization header:
Authorization: Bearer YOUR_API_KEY
https://api.example.com/v1
Retrieve a list of users.
Parameters:
limit(integer, optional): Number of results (default: 10)offset(integer, optional): Pagination offset (default: 0)
Response:
{
"users": [
{ "id": 1, "name": "John Doe" },
{ "id": 2, "name": "Jane Smith" }
],
"total": 100
}
Error Codes:
401: Unauthorized - Invalid API key429: Rate limit exceeded
Problem: Brief description of the problem being solved Solution: High-level approach Scope: What's included and what's not
Context and motivation for this design.
Goals:
- Goal 1
- Goal 2
Non-Goals:
- What we're explicitly not doing
- Future considerations
[Diagram or description of system architecture]
- User action
- System processing
- Response
Component A: Responsible for X Component B: Responsible for Y
<alternative 1>
Pros: ... Cons: ... Decision: Not chosen because...
- Data encryption at rest and in transit
- Authentication and authorization
- Input validation
- Unit tests for component logic
- Integration tests for API contracts
- E2E tests for critical user flows
- Phase 1: Internal testing
- Phase 2: Beta release (10% of users)
- Phase 3: Full rollout
Welcome! This guide will help you get started with [Product Name].
Workspace: A container for your projects Project: A collection of related items Item: The basic unit of work
- Click the "New Project" button
- Enter a project name
- Choose a template (optional)
- Click "Create"
You'll see your new project in the sidebar.
- Check your email address is correct
- Click "Forgot Password" to reset
- Contact support if the issue persists
Ensure you have a stable internet connection. The app auto-saves every 30 seconds.
Term: Definition Another Term: Another definition
Run this command to start the server.
The server can be started by running the following command.
サーバーの起動については、下記コマンドを実行することで可能となります。