issue-record-formatter

Format and validate SP-STM Issue Record notes with required frontmatter and section structure.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/xingchen2202/obsidian-ai-knowledge-system --skill issue-record-formatter
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: issue-record-formatter
Source: https://github.com/xingchen2202/obsidian-ai-knowledge-system/tree/main/skills/issue-record-formatter
Command: npx skills add https://github.com/xingchen2202/obsidian-ai-knowledge-system --skill issue-record-formatter

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill turns messy SP-STM issue/failure notes into a structured, validation-safe Issue Record with consistent frontmatter and required analytical sections, reducing ambiguity during troubleshooting and retrospectives.

Core Features & Use Cases

  • Frontmatter integrity enforcement: Validates required fields (including strict enums like issue_category and issue_status) and helps ensure consistent IDs and core experimental context (instrument, temperature).
  • Fault-structure completion: Inserts or preserves the standard section layout, and generates mandatory analytical modules such as Pre-flight Checklist, 量化损失评估, and 同类事故历史统计 while preventing prohibited auto-filling (e.g., solves).
  • Crash-specific safety/physics scaffolding: For issue_category = tip_crash, generates a foldable physical mechanism block with parameterized numeric computation and places Pre-flight Checklist in the correct position before “处理过程”.

Quick Start

Ask an assistant to format your SP-STM problem note into an Issue Record, or provide a one-sentence crash description (e.g., “15:30 scanning Co/Cu(111), the tip crashed”) to generate a complete draft with required tables.

Frequently Asked Questions about issue-record-formatter

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I format SP-STM issue notes with required frontmatter validation?

To format SP-STM issue notes with frontmatter validation, input your existing problem note or a minimal crash description. The system enforces strict frontmatter enums and inserts standardized analytical sections to produce a validation-safe Issue Record.

What is the best way to generate a complete issue record from a one-sentence tip crash description?

Generating a complete issue record from a one-sentence tip crash description involves specifying the event, such as scanning Co/Cu(111). The system scaffolds crash-specific physical mechanisms, computes parameters, and inserts a Pre-flight Checklist before the processing section.

How do I create quantifiable loss and historical statistics tables for fault notes?

Creating quantifiable loss and historical statistics tables for fault notes is automated during the formatting process. The system generates these mandatory analytical modules alongside standard section layouts to reduce ambiguity during troubleshooting retrospectives.

Does the issue record formatter auto-fill the solves field for SP-STM problem notes?

The issue record formatter does not auto-fill the solves field for SP-STM problem notes. It actively prevents prohibited auto-filling of specific fields while enforcing required frontmatter integrity and inserting mandatory analytical sections.

When do I need to use a risk checklist for SP-STM tip crash failures?

A risk checklist for SP-STM tip crash failures is needed when the issue category is set to tip_crash. The system conditionally generates a Pre-flight Checklist and places it correctly before the processing section to ensure proper troubleshooting protocols.