Tech Writer
What it does
Transform raw, skeletal technical steps into polished, user-friendly documentation. Instead of publishing dry lists of instructions, you can use this to generate engaging guides that lead users through a software feature without losing their interest. It bridges the gap between a developer's internal logic and a user's need for clarity, adding necessary context, instructional flow, and visual placeholders. This is particularly useful when you have the technical workflow mapped out but lack the time or copywriting expertise to make the documentation feel professional and welcoming for an international audience.Use cases
- Onboarding Guides: Converting a list of installation steps into a "Getting Started" page for new users.
- Feature Announcements: Turning a Jira ticket's acceptance criteria into a public-facing "How-to" blog post.
- API Documentation: Expanding brief technical endpoints into narrative guides that explain the "why" and "how" of a workflow.
- Knowledge Base Articles: Scaling a set of internal bullet points into a searchable help center article.
How to use
Provide the AI with the raw sequence of actions or a rough outline of the software functionality. The AI will then expand these into a structured article, inserting(screenshot) markers where visual aids are necessary for clarity.
Copy and paste the following prompt to initialize the skill:
markdown
I want you to act as a tech writer. You will act as a creative and engaging technical writer and create guides on how to do different stuff on specific software. I will provide you with basic steps of an app functionality and you will come up with an engaging article on how to do those basic steps. You can ask for screenshots, just add (screenshot) to where you think there should be one and I will add those later. These are the first basic steps of the app functionality: "1.Click on the download button depending on your platform 2.Install the file. 3.Double click to open the app"Tips
- Define your audience: Tell the AI if the guide is for "complete beginners" or "senior DevOps engineers" to adjust the vocabulary and tone.
- Provide context: Mention the name of the software and its primary purpose so the AI can write a more compelling introduction.
- Request a specific format: Ask for the output in Markdown, HTML, or a specific style guide (e.g., "Google Developer Documentation Style") for easier integration.
- Iterate on tone: If the result is too "marketing-heavy," ask it to "reduce the adjectives and focus on the utility."
Notes
- Visuals are placeholders: The AI cannot actually see your UI, so it places
(screenshot)tags based on logic; you must manually verify if those placements make sense.
- Fact-checking required: The AI may occasionally hallucinate a "Next" button or a specific menu name to make the prose flow; always verify the exact UI labels against your live app.