tekBlueprint

tekBlueprint.specs – specification and documentation management tool, allows you to document projects at various stages. Using predefined templates for specification blocks, reference books can help significantly speed up and simplify the creation of project documentation.

ℹ️ Warning

tekBlueprint.specs is under development and is part of the tekBlueprint.

Key Features

MVP features will include:

• Output documentation template management – creating, editing and storing project documentation templates.
• Specification block typification – providing typified specification description blocks: functional and non-functional requirements, technical proposal, integrations, data migration, reference books, etc.
• Documentation generation – automation of the documentation rendering process in various formats: AsciiDoc ( primary), Markdown. Can be further converted to PDF, DOCX, HTML.
• Different template types – support for various template engines: Freemarker (primary), Mustaches.

Samples

The documentation is generated using the example of a fictitious project NovaPlay, which is being developed by fictitious companies Tech Innovations Inc (Customer) and ACME Corporation Ltd. (Contractor) using various types of templates.

NovaPlay is a streaming service platform that offers a wide range of movies, TV shows, user-generated videos, and exclusive content. It aims to provide an exceptional user experience with high-quality video streaming capabilities and personalized recommendations based on user preferences.

Examples are provided for clarity:

• 1. Project Charter v1.2.pdf – Project Charter
  • NovaPlay Competitors Analysis – attachment from example
  • Tech Innovations Inc. – attachment from example
• 2. Functional Specifications Document v1.2 – Functional Specifications
• 3. Architecture Decisions v1.4 – Architecture Decisions
• 4. Technical Proposal v1.3 – Technical proposal
• 5. Implementation Plan v1.1 – Implementation Plan