General
PromptBeginner5 minmarkdown
After creating or updating documentation
verify:
0
Explore
Find agent skills by outcome
94,385 skills indexed with the new KISS metadata standard.
Showing 24 of 94,385Categories: Data & Insights, General, Coding & Debugging, Education, Data
Data
PromptBeginner5 minmarkdown
- Tables are used for structured data like parameters
options
0
General
PromptBeginner5 minmarkdown
- Avoid unnecessary jargon; when technical terms are needed
define them.
0
General
PromptBeginner5 minmarkdown
- File paths
variable names
0
Coding & Debugging
PromptBeginner5 minmarkdown
- Consistent use of bold
code blocks
0
Coding & Debugging
PromptBeginner5 minmarkdown
- Code examples are tested
complete
0
Coding & Debugging
PromptBeginner5 minmarkdown
- Provide contribution guidelines covering code style
PR process
0
General
PromptBeginner5 minmarkdown
- Produce release notes with changelogs
migration guides
0
General
PromptBeginner5 minmarkdown
- Include pagination
filtering
0
General
PromptBeginner5 minmarkdown
- Include parameter types
return types
0
General
PromptBeginner5 minmarkdown
- Document authentication methods
rate limits
0
General
PromptBeginner5 minmarkdown
- Ensure consistency in terminology
formatting
0
General
PromptBeginner5 minmarkdown
- Apply consistent formatting
heading hierarchy
0
General
PromptBeginner5 minmarkdown
- Use clear
jargon-free language while maintaining technical accuracy.
0
General
PromptBeginner5 minmarkdown
- Include practical
tested
0
Coding & Debugging
PromptBeginner5 minmarkdown
- Collect error codes
edge cases
0
Coding & Debugging
PromptBeginner5 minmarkdown
- Read the source code to understand actual behavior
not just intended behavior.
0
General
PromptBeginner5 minmarkdown
- Identify prerequisites
dependencies
0
Coding & Debugging
PromptBeginner5 minmarkdown
- Determine the documentation type needed (API reference
tutorial
0
Coding & Debugging
PromptBeginner5 minmarkdown
- Identify the target audience (internal team
external developers
0
Coding & Debugging
PromptBeginner5 minmarkdown
- **Maintain** developer guides covering local setup
development workflow
0
Education
PromptBeginner5 minmarkdown
- **Author** user guides with step-by-step tutorials
feature walkthroughs
0
General
PromptBeginner5 minmarkdown
- **Produce** operational runbooks for deployment
monitoring
0
Coding & Debugging
PromptBeginner5 minmarkdown
- **Create** comprehensive API documentation with OpenAPI specs
endpoint descriptions
0