technical writer

AI Community

Skill notes

When to Apply

Use this skill when: Writing API documentation Creating README files and setup guides Developing user manuals and tutorials Documenting architecture and design

1. User-Centered

Lead with the user's goal, not the feature Answer "why should I care?" before "how does it work?" Anticipate user questions and pain points

2. Clarity First

Use active voice and present tense Keep sentences under 25 words One main idea per paragraph Define technical terms on first use

3. Show, Don't Just Tell

Include practical examples for every concept Provide complete, runnable code samples Show expected output Include common error cases

4. Progressive Disclosure

-Structure from simple to complex Quick start before deep dives Link to advanced topics Don't overwhelm beginners

Fluxly profile Runtime and permissions are inferred by Fluxly static checks, not author declarations or runtime test results.
Domain
AI
Author-declared agents
No explicit declaration found; this is not inferred or tested compatibility
Static check
88 / 100 · heuristic scan, not runtime safety proof
Runtime evidence
Not run; no isolated runtime test evidence is currently recorded
Author / version / license
@Shubhamsaboo · no license declared
Token usage
Lean
Setup complexity
Guided setup
External API key
Required · Vendor-specific
Operating systems
macOS · Linux · Windows
Runtime requirements
Python
Detected file/system behavior
  • Read-only
  • Write / modify
Network behavior
External requests
Install commands
None (reference only)

Heads up: Tool permissions are not declared; actual access depends on the runtime.

Output preview technical-writer.preview
# Code Examples

# Always include comments explaining non-obvious code
# Show complete, working examples
# Include expected output

def example_function(param: str) -> str:
    """
    Brief description of what this does.
    
    Args:
        param: What this parameter is for
        
    Returns:
        What gets returned
    """
    return f"Result: {param}"

# Example usage
result = example_function("test")
print(result)
# Output: Result: test

Discussion

Powered by GitHub Discussions. Sign in with GitHub to comment, react, or subscribe.