git:20251226.0b3ca74 to git:20251226.c184618

---

name: tech-documentation

description: Technical documentation writing skill covering API docs, architecture documentation, deployment guides, and various technical writing best practices. Use this skill when creating technical documentation, writing API documentation, creating architecture design documents, or need templates for deployment and operations manuals.

allowed-tools: Read, Grep, Glob, Edit, Write

---

# Tech Documentation Skill

````markdown

- **Base URL**: `https://api.example.com/v1`

```http

POST /auth/token

Content-Type: application/json

{

"username": "user@example.com",

"password": "password"

}

```

```json

{

"access_token": "eyJhbGciOiJIUzI1NiIs...",

"token_type": "Bearer",

"expires_in": 3600

}

```

```http

POST /users

Authorization: Bearer {token}

Content-Type: application/json

{

"email": "user@example.com",

"name": "John Doe",

"role": "user"

}

```

```json

{

"id": 123,

"email": "user@example.com",

"name": "John Doe",

"role": "user",

"created_at": "2024-12-16T10:00:00Z"

}

```

```json

{

"error": {

"code": "EMAIL_EXISTS",

"message": "Email already registered",

"field": "email"

}

}

```

### v1.1.0 (2024-12-16)

### v1.0.0 (2024-12-01)

````

````markdown

| API | Application Programming Interface |

| QPS | Queries Per Second |

```

┌─────────┐

│ Client │

└────┬────┘

│

↓

┌─────────────┐

│ API Gateway │

└──────┬──────┘

│

┌───┴───┬─────────┐

↓ ↓ ↓

┌─────┐ ┌─────┐ ┌─────┐

│Svc A│ │Svc B│ │Svc C│

└──┬──┘ └──┬──┘ └──┬──┘

↓ ↓ ↓

┌─────┐ ┌─────┐ ┌─────┐

│ DB │ │Cache│ │ MQ │

└─────┘ └─────┘ └─────┘

```

#### API Gateway

```sql

CREATE TABLE users (

id SERIAL PRIMARY KEY,

email VARCHAR(255) UNIQUE NOT NULL,

name VARCHAR(100) NOT NULL,

created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP

);

```

```

Write: Client → Service → DB → Cache (async)

Read: Client → Service → Cache → DB (if miss)

```

- RESTful API

- OAuth 2.0 + JWT

- ELK Stack

````

````markdown

- Docker: 20.10+

- Kubernetes: 1.25+

- Helm: 3.10+

```bash

kubectl create namespace myapp-prod

```

```bash

kubectl create secret docker-registry regcred \

--docker-server=registry.example.com \

--docker-username=user \

--docker-password=password \

-n myapp-prod

```

```bash

helm install mysql bitnami/mysql \

--set auth.rootPassword=secretpassword \

--set primary.persistence.size=50Gi \

-n myapp-prod

```

```bash

kubectl exec -it mysql-0 -n myapp-prod -- \

mysql -uroot -psecretpassword < schema.sql

```

```bash

helm install redis bitnami/redis \

--set auth.password=redispassword \

--set replica.replicaCount=2 \

-n myapp-prod

```

```yaml

image:

repository: registry.example.com/myapp

tag: v1.0.0

pullPolicy: IfNotPresent

replicaCount: 3

resources:

limits:

cpu: 1000m

memory: 1Gi

requests:

cpu: 500m

memory: 512Mi

env:

- name: SPRING_PROFILES_ACTIVE

value: prod

- name: DB_HOST

value: mysql.myapp-prod

- name: REDIS_HOST

value: redis-master.myapp-prod

```

```bash

helm install myapp ./helm-chart \

-f values.yaml \

-n myapp-prod

```

```yaml

apiVersion: networking.k8s.io/v1

kind: Ingress

metadata:

name: myapp-ingress

namespace: myapp-prod

annotations:

cert-manager.io/cluster-issuer: letsencrypt-prod

spec:

tls:

- hosts:

- api.example.com

secretName: myapp-tls

rules:

- host: api.example.com

http:

paths:

- path: /

pathType: Prefix

backend:

service:

name: myapp

port:

number: 80

```

```bash

kubectl apply -f ingress.yaml

```

| SPRING_PROFILES_ACTIVE | Spring Profile | prod |

```yaml

server:

port: 8080

spring:

datasource:

url: jdbc:mysql://${DB_HOST}:3306/myapp

username: ${DB_USER}

password: ${DB_PASSWORD}

```

```bash

kubectl get pods -n myapp-prod

```

```

NAME READY STATUS RESTARTS AGE

myapp-6d4f7b5c9-abc12 1/1 Running 0 2m

myapp-6d4f7b5c9-def34 1/1 Running 0 2m

myapp-6d4f7b5c9-ghi56 1/1 Running 0 2m

```

```bash

curl https://api.example.com/actuator/health

```

```json

{

"status": "UP"

}

```

```bash

kubectl logs -f deployment/myapp -n myapp-prod

```

```bash

helm upgrade myapp ./helm-chart \

--set image.tag=v1.0.1 \

-n myapp-prod

```

```bash

helm history myapp -n myapp-prod

helm rollback myapp -n myapp-prod

helm rollback myapp 3 -n myapp-prod

```

### Prometheus

```yaml

apiVersion: v1

kind: ServiceMonitor

metadata:

name: myapp

namespace: myapp-prod

spec:

selector:

matchLabels:

app: myapp

endpoints:

- port: metrics

interval: 30s

```

### Grafana Dashboard

```bash

kubectl exec mysql-0 -n myapp-prod -- \

mysqldump -uroot -p$MYSQL_ROOT_PASSWORD myapp > backup.sql

```

```bash

kubectl scale deployment myapp --replicas=5 -n myapp-prod

```

```bash

kubectl rollout restart deployment/myapp -n myapp-prod

```

```bash

kubectl get all -n myapp-prod

kubectl exec -it <pod-name> -n myapp-prod -- /bin/bash

kubectl port-forward svc/myapp 8080:80 -n myapp-prod

kubectl get events -n myapp-prod --sort-by='.lastTimestamp'

```

````

```

- README.md

```

```

```

```

```

```

```

```json

{

"agent": "tech-writer",

"skills": [

"tech-documentation",

"system-architecture",

"api-design"

]

}

```

```

```

- [Google Developer Documentation Style Guide](https://developers.google.com/style)

- [Microsoft Writing Style Guide](https://docs.microsoft.com/style-guide/)

- [Write the Docs](https://www.writethedocs.org/)

---