AutoBE
    Preparing search index...

    Interface IFile

    Planning document structure for the Analyze phase.

    interface IFile {
        audience?: string;
        constraints?: string[];
        content: string;
        detailLevel?: string;
        documentType?: string;
        filename: `${string}.md`;
        keyQuestions?: string[];
        module: IModule;
        outline?: string[];
        reason: string;
        relatedDocuments?: string[];
        summary: string;
        title: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    audience? constraints? content detailLevel? documentType? filename keyQuestions? module outline? reason relatedDocuments? summary title

    Properties

    audience?: string

    Target audience (e.g., "development team", "business stakeholders"). Defaults to general audience.

    constraints?: string[]

    Must-have constraints the document must satisfy.

    content

    content: string

    Markdown file content. Must be a standalone deliverable.

    PROHIBITED: questions to the reader, feedback requests, interactive elements, or meta-commentary about the writing process.

    detailLevel?: string

    Level of detail (e.g., "high-level overview", "detailed specification").

    documentType?: string

    Document type (e.g., "requirement", "user-story", "business-model").

    filename: `${string}.md`

    Filename to generate or overwrite (e.g., "01-service-overview.md").

    keyQuestions?: string[]

    Key questions this document should answer.

    module: IModule

    Hierarchical content structure (Module -> Unit -> Section). Preserves the three-level hierarchy that flat markdown loses.

    outline?: string[]

    Table of contents guiding the document structure.

    reason: string

    Why this document is being created and what comes next.

    relatedDocuments?: string[]

    Related documents this one references or builds upon.

    summary: string

    Executive summary of the document.

    title: string

    Document title.

    Settings

    Member Visibility

    On This Page

    Properties