No Type In Docs

What it does

This skill allows AI agents to generate documentation without including TypeScript type annotations. It removes the noise of types from generated text, focusing solely on the descriptive aspects of code or configuration. This results in cleaner, more readable documentation for users who may not be familiar with TypeScript.

When to use it

• Generating API reference documentation where type information is less relevant than usage examples.
• Creating user-facing guides that should avoid technical jargon like type annotations.
• Producing markdown documentation from code comments or docstrings, ensuring a simplified output.
• Automating the creation of internal knowledge base articles for non-technical team members.

Key capabilities

• Removes TypeScript type annotations from generated text.
• Focuses on descriptive content during documentation generation.
• Produces cleaner and more readable documentation.

Example prompts

• "Generate markdown documentation for this function, excluding type information."
• "Create a user guide explaining this configuration file without mentioning types."
• "Document these code comments as a markdown article, removing all TypeScript annotations."

Tips & gotchas

This skill is most effective when the source material contains both descriptive text and TypeScript type annotations. Be aware that some information may be lost if it's solely conveyed through types.