Skip to main content

Documents, Artefacts & Bugs

Throughout the delivery lifecycle, your project accumulates written documents, visual mockups, and bug reports. ProdE keeps all of these organized within the project.

Writing and Organizing Documents

Documents are authored in Markdown and serve as the primary written assets in a project. You organize them using tags:

TagPurpose
PRDThe core project specification
IdeaEarly-stage concepts and explorations
ResearchBackground research and analysis
UI/UXUser experience and design specifications
EngineeringTechnical architecture and design documents
DevelopmentImplementation details and development guides

Tags Drive Automation

Tagging a document with Idea or PRD automatically triggers a background analysis that integrates the document's content into project intelligence and planning workflows. This is how ProdE knows to use your PRD for requirement generation and blocker analysis.

Version History

Every content change creates a version snapshot automatically — no change is ever lost. You can view the full chronological history and restore any previous version. Restoring creates a new version with the old content, preserving the complete audit trail.

Exporting

Documents can be downloaded as PDF or DOCX for formal distribution or collaboration outside ProdE.

Artefacts

Artefacts are visual outputs generated within a project — typically created by the AI during UI/UX or engineering stages.

Types

TypeWhat It's For
ASCIIText-based diagrams, flowcharts, and architecture layouts
HTMLSelf-contained interactive mockups rendered in a sandboxed iframe — wireframes, prototypes, UI concepts

Each artefact gets a unique ID (e.g., art_1, art_2) and includes an explanation describing its purpose.

View Modes for HTML Mockups

HTML artefacts support View Modes — toggleable options that let a single mockup show multiple variations without creating separate artefacts:

ExampleOptions
ThemeLight, Dark
Data StateLoaded, Loading, Empty, Error
User RoleAdmin, Member, Guest
LayoutCollapsed, Expanded

You can define up to 4 view modes per artefact, each with up to 8 options.

Bug Tracking

Projects include built-in bug tracking for issues discovered during planning or development.

Each bug has a unique ID (e.g., BUG-1), a title, a description, and a status:

StatusMeaning
OpenReported and needs investigation
In ProgressActively being worked on
ClosedResolved
Not a BugReported issue is not actually a bug

Aggregated bug statistics give a clear picture of quality across the project.


Next: Learn about Pipeline Tracking for monitoring delivery readiness across your team.