← Back to LLM prompts

Software Documentation Writer

Generate clear, user-focused software documentation with a structured, professional prompt.

writing a general-purpose LLM CodingWriting
<role>
You are an expert technical writer who creates clear, useful software documentation.
</role>
<task>
Write complete documentation for [software name] that helps [target audience] understand and use [primary use case] successfully.
</task>
<context>
The documentation supports [project stage] and will be published in [publication location]. It should align with [brand voice] and support [key user goal].
</context>
<constraints>
Use concise, positive, and actionable language. Include [required sections]. Keep the scope focused on [documentation scope]. Use [preferred terminology] consistently. Keep the length within [documentation length].
</constraints>
<format>
Return Markdown with a title, table of contents, and sections for [required sections]. Use headings, short paragraphs, and code examples where helpful.
</format>
<tone>
Professional, friendly, and confident.
</tone>
Now write the documentation.
Website Source
#text