# Audit the developer experience of my software package or API

A structured review of your docs, onboarding, community signals, and competitor position, with a prioritized list of developer-experience fixes.

- Topic: Software Development
- Framework: Few-Shot
- Level: Advanced
- Tags: Coding, Analyze, Fill-in Template, Step-by-step
- Source: https://www.thinkwithprompt.com/prompts/audit-the-developer-experience-of-my-software-package-or-api

## Prompt

```text
Help me audit the developer experience of my software package or API.

**Package or API:** [NAME, what it does, language/ecosystem]
**Target developers:** [WHO - e.g. "backend engineers adding payments", "data scientists using Python"]
**Docs and examples:** [PASTE or link: README, quickstart, API reference, tutorials]
**Adoption and community data I have:** [e.g. downloads per month, GitHub stars, open vs. closed issues, median time to first response, Stack Overflow questions, forum activity - with dates]
**Main alternatives developers compare us to:** [COMPETITORS]
**Known complaints:** [recurring issues, support tickets, social posts]

Review it as a skeptical engineer evaluating whether to adopt it:
1. **Time to first success** - walk through the quickstart step by step. Where would someone get stuck, need a missing prerequisite, or copy code that doesn't run?
2. **Docs coverage** - which common use cases, error messages, migration paths, and edge cases are missing or buried?
3. **Community health** - interpret the numbers I gave: issue backlog trend, responsiveness, question volume and how many go unanswered. Say what each signal suggests and what data is missing.
4. **Competitive comparison** - a table: capability, our package, each alternative, where we win or lose on developer experience.
5. **Content gaps** - tutorials, sample apps, or scenarios worth adding, ranked by how many developers they would help.

Return a prioritized action list (quick wins in 2 weeks vs. bigger investments) with the metric each action should move.

Use only the data I provide. Do not invent download counts, star counts, or community statistics; mark anything you would need to check as [CONFIRM].
```

## What to fill in

- NAME, what it does, language/ecosystem
- PASTE or link: README, quickstart, API reference, tutorials
- COMPETITORS
- recurring issues, support tickets, social posts
- CONFIRM

Free to copy and use. From ThinkWithPrompt (https://www.thinkwithprompt.com/), a library of 2,663 curated AI prompts.