Skip to main content
Thank you for your interest in contributing! This project aims to help developers create better documentation faster by providing proven templates and best practices.

​
Before You Contribute

Important: Please open an issue to discuss your proposed contribution before submitting a pull request.
Why start with an issue?
  • These templates are often created to contribute to other larger projects
  • You might want to contribute directly to those projects instead
  • Discussion helps ensure your work aligns with project goals
  • It prevents duplicate effort and wasted time

​
Ways to Contribute

Request Help

If you’re a software engineer who needs additional guidance—like suggested workflows or better explanations of how to use the templates—let us know by opening an issue.

Report Issues

Found a problem with a template? Notice unclear instructions or missing information? Open an issue to help us improve.

Propose New Templates

Have an idea for a new template type? Start a discussion by opening an issue outlining the template’s purpose and audience.

Improve Existing Templates

See ways to enhance current templates? Share your suggestions through an issue first.

​
Contribution Process

1

Open an Issue

Start by creating an issue that describes:
  • What you want to contribute (new template, improvement, bug fix)
  • Why this contribution is valuable
  • Who will benefit from this change
  • Any relevant context or examples
Issue Template Ideas:
## Contribution Type
[New template / Enhancement / Bug fix / Documentation]

## Description
[Clear description of what you want to contribute]

## Rationale
[Why is this needed? What problem does it solve?]

## Target Audience
[Who will use this? Software engineers, technical writers, etc.]

## Additional Context
[Links, examples, or other relevant information]
2

Discuss and Refine

Engage with maintainers and community members:
  • Respond to questions and feedback
  • Refine your proposal based on discussion
  • Confirm that your contribution aligns with project direction
  • Check if there are related projects where this contribution might be better placed
The maintainer may suggest contributing to a larger project that uses these templates. This is an opportunity, not a rejection—your work may have greater impact elsewhere.
3

Create Your Contribution

Once your issue has been discussed and approved:

​
For New Templates

  1. Use the meta-template framework to structure your template
  2. Include all required sections:
    • Template summary (purpose, audience, when to use)
    • Prerequisites
    • Template body
    • Postrequisites
    • More information
  3. Provide at least one real-world example
  4. Test your template by using it yourself

​
For Improvements

  1. Make focused changes that address the discussed issue
  2. Maintain consistency with existing templates
  3. Update any affected documentation
  4. Test that examples still work
4

Submit a Pull Request

When ready to submit:
  • Reference the issue number in your PR description
  • Clearly describe what changed and why
  • Include before/after examples if relevant
  • Ensure all content follows the project’s style guide
  • Check that code blocks have proper language tags
Pull Request Template:
## Related Issue
Closes #[issue number]

## Description
[Summary of changes]

## Changes Made
- [List specific changes]

## Testing
[How you validated these changes]

## Additional Notes
[Any other relevant information]

​
Current Project Status

Ready to Use

  • Quickstart template
  • Overview template

In Progress

  • Reference template (work in progress)
  • Setup template (not yet started)

​
Template Types

The current focus is on API documentation templates:
Template NameDescriptionStatus
ReferenceExhaustive listing of all endpoints with consistently formatted parametersIn Progress
QuickstartWorkflow describing the simplest way to get value from the APIComplete
OverviewBasic information about what the service does, problems it solves, and how it worksComplete
SetupInstallation and environment configuration proceduresNot Started

​
Guidelines for Contributors

​
Who This Project Serves

Primary audience:
  • Software engineers who need to create documentation quickly
  • Technical writers looking for proven templates
  • Development teams establishing documentation standards

​
Why These Templates Matter

Leverage Collective Knowledge

Others have spent years figuring out which documents users need. These templates capture that knowledge so you don’t have to invest the same time.

Know What to Include

Templates tell you what content each document should contain and explain why, removing guesswork from the documentation process.

Create Docs Faster

With structure provided, you can focus on explaining how your product works rather than figuring out document organization.

Benefit Users

Following proven patterns helps users save time learning your product, reduces frustration, and accelerates adoption.

​
Quality Standards

Contributions should:
  • ✅ Address a real documentation need
  • ✅ Follow the meta-template structure
  • ✅ Include clear examples
  • ✅ Use plain language and avoid jargon
  • ✅ Be tested with real documentation
  • ✅ Include proper context (prerequisites, next steps)

​
Questions or Need Help?

Open an Issue

The best way to get help is to open an issue describing what you need. Whether you’re stuck, have questions, or want to propose something new—start the conversation!

​
Recognition

All contributors will be recognized for their work. Your contributions help developers worldwide create better documentation and serve their users more effectively.

​
Next Steps

Review the Meta-Template

Understand the framework before creating new templates

Explore Existing Templates

See the templates in action to understand the standards

Build docs developers (and LLMs) love

Get started for freeTalk to us