Sign up for the Good Docs Project user research

The Good Docs Project  — Many team members contributed to posts from this author.
Feb 27, 2025 501 words

Join our user research to help shape the future of documentation templates and improve the Good Docs Project.

Rule number one of technical writing is "know your audience". As the team behind The Good Docs Project, we’ll admit that we’re a bit embarrassed: we don’t know who are users are. We know that we want our templates to be used by developers because most documentation is written by them. However, we are not really sure we truly understand their needs and pain points. We have the curse of knowledge, and we need your help to overcome it.

That’s where you come in. As someone who writes software documentation, you are uniquely qualified to provide the insights we’re missing. Your participation in our user research will directly shape how we support documentation contributors like you in the future.

Sign up for The Good Docs Project user research today and help us create documentation that works for everyone.

Who we are looking for

You are a good candidate for our study if you can answer 'yes' to any of the following:

  • I have recently approached a task to document a software project (no matter if it’s a work or a personal project).

  • I am interested in or have used documentation templates.

  • I have used The Good Docs Project templates or other documentation templates.

What to expect

If you sign up to participate in our research, you would agree to join us for one research session. Here’s what you can expect:

  • Duration: The interview will last approximately 45 minutes and will be conducted over Zoom.

  • During the meeting: You will be the only interviewee on the call, it will be a private session between you and The Good Docs Project folks (usually 2 people, the interviewer and the note-taker). During the call, we’ll engage in a friendly conversation about your experiences with documentation for software projects and your use of templates to streamline the process. You don’t have to prepare anything: just bring your experiences and insights!

  • Language: The session will be conducted in English. No pressure: Remember, this isn’t a test! There are no right or wrong answers, just your honest insights.

  • After the meeting: Your feedback will be carefully evaluated by The Good Docs team. Your experiences will help The Good Docs Project shape and evolve its offerings to empower you to write your best docs. We will use the collective input to shape the direction of future templates. Plus, if you’re interested, you can stay updated through our community Discord, GitLab repo, or follow-up emails.

How your input will shape the future of documentation

Your feedback won’t just sit in a report. Here’s how we’ll put your insights to work:

  • Create more effective and tailored templates: Help us produce documentation templates that are efficient, and tailored to your needs.

  • Identify common challenges: Share your frustrations so we can prioritize our templates roadmap, ensuring our templates and resources evolve to better serve you.

Sign me up!

Sign up here to fill out a small survey and take part in the research.


Image of The Good Docs Project
Please see The Good Docs Project website (https://thegooddocsproject.dev) for more information.

Continue Reading