AutoBE
    Preparing search index...

    Interface IFileScenario

    Planning context for a document to be generated. IFile extends this.

    interface IFileScenario {
        audience?: string;
        constraints?: string[];
        detailLevel?: string;
        documentType?: string;
        filename: `${string}.md`;
        keyQuestions?: string[];
        outline?: string[];
        reason: string;
        relatedDocuments?: string[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    audience? constraints? detailLevel? documentType? filename keyQuestions? outline? reason relatedDocuments?

    Properties

    audience?: string

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

    constraints?: string[]

    Must-have constraints the document must satisfy.

    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.

    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.

    Settings

    Member Visibility

    On This Page

    Properties