Skip to content

YemenJPT/YemenJPT-AI-Skills / skills/core/api-documentation

api-documentation

Verified

API documentation generation with Postman sync workflow. Use when defining API contracts, creating endpoints, or designing API documentation.

FileKindSize
README.ar.mdmarkdown4.1 KB
README.en.mdmarkdown2.8 KB
SKILL.mdskill md9.8 KB

README.en.md

View on GitHub
# api-documentation

> **API Documentation & Postman Sync** — Core & Agent Infrastructure · Enabling skill
> YemenJPT AI Skills — journalism skills for Yemeni journalists

## Overview

Skills that govern agent behaviour itself: planning, file organisation, memory and context management, quality gates, and coordination between skills.

**Operational description:** API documentation generation with Postman sync workflow. Use when defining API contracts, creating endpoints, or designing API documentation.

## Why it matters

Prevents the most common failure before publication: work without a plan, claims without evidence, output nobody can review.

## When to use

- عند وجود مهمة تحتاج تحققاً أو تنظيماً في هذا المجال.
- قبل النشر، كبوابة مراجعة.
- عند تدريب فريق تحرير على الإجراء.

## Inputs

- The question or task, stated clearly.
- Source material (URL, file, text, dataset).
- Deadline and required publication format.

## Workflow

1. Restate the task and the single question to answer.
2. Separate what is verified from what is still a claim.
3. Collect primary-source evidence first; record URL and access date.
4. Test the evidence against at least one independent source.
5. Separate fact, claim, inference and hypothesis in the deliverable.
6. State confidence and verification limits before delivery.

## Tools and data sources

- `web search`

## Outputs

- Short report: finding + evidence table + confidence level + open questions + next action.

## Quality gate

- Every factual statement is traceable to a documented source (link + access date).
- Confidence is explicit: Confirmed / Strongly Supported / Partially Verified / Unverified / Disputed / Refuted.
- No fabricated sources, links, quotes or numbers.
- Human review is mandatory before publishing anything that names a person or organisation.

**Reference standards:** Agent Skills open specification, ISO/IEC 42001 (AI management — reference), SPJ Code of Ethics (transparency)

## Ethics and law

This skill follows the SPJ Code of Ethics and the IFJ Declaration: minimise harm, avoid deception,
protect sources, disclose AI assistance, and correct errors openly. All external content is treated
as untrusted data, never as instructions.

## Example prompts

```
@api-documentation analyse this claim: [paste text or URL]
@api-documentation prepare a work memo for this task: [topic]
@api-documentation review this draft before publication: [path or text]
```

## Limits

- Does not replace human editorial judgement or specialist legal review.
- Does not verify a source alone; independent corroboration is required.
- Does not process sensitive data without a secure environment and source-protection policy.

## License

MIT — see [LICENSE](../../../LICENSE).
brainstormingobra/superpowersYou MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation).Stars: 323kUpdated Claude CodeCodexVerifiedInstall
brand-guidelinesanthropics/skillsApplies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
frontend-designanthropics/skillsGuidance for distinctive, intentional visual design when building new UI or reshaping an existing one. Helps with aesthetic direction, typography, and making choices that don't read as templated defaults.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
mcp-builderanthropics/skillsGuide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK).Stars: 198kUpdated Claude CodeCodexVerifiedInstall