tech-spec-writer

To write an implementation-ready technical specification, you need to define functional and non-functional requirements, architecture, data models, and API endpoints. The skill generates this structured documentation in markdown format, capturing explicit assumptions and testable requirements for senior engineers.

A complete technical specification should include functional requirements, non-functional requirements, architecture, data models, APIs, error handling, and testing strategies. It also needs to document explicit assumptions and open questions to guide engineering implementation effectively.

Yes, markdown is used to structure requirements and testing strategies into a clear technical specification. This format supports detailed documentation of data models, error handling, and APIs, ensuring senior engineers can easily read and implement the specifications.

To elicit and document open questions during technical documentation, the skill guides users through clarifying questions to define scope, goals, and constraints. It then captures these open questions and explicit assumptions directly within the markdown specification.

The best way to document software architecture and data models for engineering review is to generate a structured technical specification. This ensures all functional requirements, error handling, and testing strategies are systematically formatted in markdown for immediate implementation.