agentleFS
spmtitsolutionspmtitsolution/OpenBA-Kit/skills/preview/SKILL.md

preview

Skill38 starsChanged 22 days agoMITView on GitHub

Trang HTML xem toàn bộ tài liệu của một tính năng

18 other projects use a version of this, 1 of them edited.

Adopted by

Most recently taken up by

Used with

Projects with it also use ml-training-recipe, replication and 8 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • getcompanion-aiSkill

    ml-training-recipe

    Find implementable ML training recipes from papers, datasets, docs, and code. Use when the user wants to fine-tune, train, reproduce, or choose a practical ML method, dataset, hyperparameter setup, or benchmark recipe.

    Also in 3 projects that use this

  • getcompanion-aiSkill

    replication

    Plan a replication of a paper, claim, or benchmark, and execute only after an explicit environment choice. Use when the user asks to replicate results, reproduce an experiment, verify a claim empirically, or build a replication package.

    Also in 3 projects that use this

  • brainbytes-devSkill

    alpha-research

    Also in 3 projects that use this

  • JaimeParkerSkill

    paper-code-audit

    Perform three-way cross-validation of a research paper by comparing the original paper text (via Zotero), official code implementation (via Git), and personal Obsidian notes. Use this skill whenever the user wants to "audit a paper", "verify paper claims against code", "cross-check notes with implementation", "triangulate paper + code + notes", "find discrepancies between paper and code", or mentions wanting a deep, structured comparison of a paper's claims against its implementation and their own notes. Also trigger when the user asks to "analyze this paper thoroughly" with code available, or when they want to systematically reconcile what the paper says, what the code does, and what their notes claim.

    Also in 3 projects that use this

  • JimLiuSkill

    pdf-explore

    Use this skill when the user has attached a PDF, paper, report, or other document and the answer needs content from more than one place in it: summarize the methods or any other section, compare sections, find where a topic is discussed, read a value or label off a figure or chart, or find/list/extract every instance of something across the whole document (datasets, benchmarks, citations, figures, table rows, accession numbers — including appendices). Skip it only for a single lookup of 1–4 pages quoted in your very next response — `read_file(pages=[...])` attaches pages as images that are dropped from context after one turn, so multi-section answers end up re-reading the same ranges repeatedly. Parses the PDF once in the Python kernel: `pdf_pages` (pages as persistent text), `pdf_outline` (TOC), `pdf_scan` (rank pages by relevance), `pdf_map`/`pdf_extract` (per-page summary / structured fields via parallel haiku calls). For PDF creation/manipulation, use reportlab/pypdf directly.

    Also in 3 projects that use this

  • KISHOR403Skill

    session-search

    This skill should be used when searching Claude Code session transcripts with semantic understanding. Triggers on queries like "find sessions about X", "when did I work on Y", "search previous conversations". Supports natural language queries with synonym matching.

    Also in 3 projects that use this

  • +1 more from getcompanion-ai

The file

Files
SKILL.md

/preview — Trang HTML Duyệt Toàn bộ Tài liệu Tính năng [STANDARD WORKFLOW]

Trang HTML xem toàn bộ tài liệu của một tính năng

Mục tiêu

Cung cấp hướng dẫn chuyên gia BA để thực thi lệnh /preview, sinh ra tài liệu chất lượng cao, có thể đưa vào sản xuất ngay lập tức mà không cần chỉnh sửa lại format.

Quy chuẩn bắt buộc tuân thủ (Rules)

  • rules/18-knowledge-graph-metadata.md

Biểu mẫu tham chiếu (Template)

  • _templates/31-wireframe-html.html

Vị trí lưu tệp mặc định

  • docs/{feature}/preview.html

Workflow thực hiện

  1. Kết xuất trực quan toàn bộ sơ đồ:
    • Chạy lệnh python3 scripts/render_diagrams.py docs/{feature}/ để tự động biến các khối Mermaid thô thành bản vẽ visual HTML/SVG chuẩn diagram-design.
  2. Tổng hợp dữ liệu:
    • Gom toàn bộ hồ sơ tính năng: Brainstorm, SRS, Wireframe, Stories, Test Cases, và thư mục diagrams/ vừa kết xuất.
  3. Tạo trang HTML tổng hợp:
    • Nhúng trực tiếp bản vẽ visual SVG/HTML vào mục Sơ đồ kiến trúc / Luồng dữ liệu (có kèm nút xem Fullscreen hoặc tải file SVG vector).
    • Có thanh điều hướng bên trái (Sidebar) giúp stakeholder xem toàn bộ hồ sơ tính năng chỉ với 1 click.
  4. Ghi file:
    • Lưu vào docs/{feature}/preview.html.

Tiêu chí Nghiệm thu (Quality Checklist)

  • Sử dụng ngôn ngữ tiếng Việt chuyên nghiệp, đúng thuật ngữ IT BA.
  • Không chứa các từ ngữ mơ hồ định tính (Rule 16).
  • Tuân thủ quy ước đặt mã chuẩn (FR/BR/ERR/UC/US).
  • Lưu đúng vị trí tệp quy định trong dự án.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.