一键导入
new-kb-article
write a new KB article, generate knowledge base article, draft a KB doc, create a new article, write documentation, create MDX article
用 Codex 或 Claude 帮你安装 复制这段 Prompt,粘贴到 Codex、Claude 或其他助手里,让它检查 Skill 页面并帮你完成安装。
菜单
write a new KB article, generate knowledge base article, draft a KB doc, create a new article, write documentation, create MDX article
用 Codex 或 Claude 帮你安装 复制这段 Prompt,粘贴到 Codex、Claude 或其他助手里,让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
| name | new-kb-article |
| user-invocable | true |
| description | write a new KB article, generate knowledge base article, draft a KB doc, create a new article, write documentation, create MDX article |
| argument-hint | article title or topic, or paste any source material |
Generate a new Domo Knowledge Base article as an MDX file.
The user will provide: $ARGUMENTS
Before writing anything, invoke the kb-intake skill, passing $ARGUMENTS directly as the input. Let the Socratic intake conversation run to completion, ending with the Article Intake Summary.
Use the original source material and the Article Intake Summary as the authoritative source of truth for everything that follows — it defines the title, persona, structure, scope, and key details of the article. If there are conflicts between the original source material and the Article Intake Summary, the Article Intake Summary takes precedence. Be sure to call out any discrepancies and be clear to the user about which information is taken as the truth.
Before gathering release information, identify the PM who owns this article's feature area. Search Article-PM-Ownership-Reference.mdx for the closest matching Feature name:
grep -i "feature keyword" Article-PM-Ownership-Reference.mdx | head -5
If the feature is brand-new and not yet in the reference, find the closest matching Feature in the reference (or in Feature - Owning Squad, PM, Eng, UX.csv) and note that PM as the likely owner. Surface the PM name to the user so they can route review, approvals, or follow-up questions.
After the Article Intake Summary is confirmed, ask the following two questions before writing:
Before writing, read both of these files:
Domo-KB-Style-Guide.mdx — the authoritative style guide. Apply every rule in this file when writing the article.New-Article-Template.mdx — the canonical file structure and encoding conventions (frontmatter, section order, image syntax, callout components, code blocks, tables, etc.). Use this as the structural template for the new article.Once the Article Intake Summary, release information, style guide, and template are all loaded, create the MDX file. Do not ask for any information already answered.
Create a new MDX file in s/article/ using the filename format Article-Title-Here.mdx (Title Case, hyphen-separated, no special characters).
Follow the structure from New-Article-Template.mdx and apply all style rules from Domo-KB-Style-Guide.mdx exactly.
When writing the Required Grants section, do not invent grant descriptions. Most grants are already described in the standard format elsewhere in the KB — search for and reuse the existing wording so the grant reads consistently across articles:
grep -rn "Grant Name —" s/article/
Reuse the existing description verbatim (adjusting only to fit the em-dash format). If no article describes the grant, write a concise one-sentence description and flag it to the user as newly authored. See Domo-KB-Style-Guide.mdx › Required Grants › Use canonical grant wording.
Use the release-status answer from Step 3 to decide which beta treatment, if any, to apply. The full convention lives in Domo-KB-Style-Guide.mdx › Beta Features — read it before writing.
tag: "Beta" to the frontmatter and place the standard beta Note immediately after the frontmatter, above the Intro. Do not append (Beta) to the title.<Badge className="text-primary bg-primary/10 font-bold">Beta</Badge> to each beta section's heading. Place the standard beta Note under the first beta section only — do not repeat it for subsequent beta sections in the same article. Do not append (Beta) to any heading.The className on the Badge is required and must be exactly text-primary bg-primary/10 font-bold — it matches the sidebar tag styling.
The standard beta Note must be used verbatim — do not paraphrase or change the links. Copy it from the style guide.
Drafting always introduces style drift. Before finalizing, do an explicit pass against the style guide and revise the article in place. Do not skip this even if the draft looks right — the most common misses (intro framing, imperative headings, unpadded tables, lowercase Domo terms, future tense) are easy to introduce and easy to miss without a deliberate re-read.
Domo-KB-Style-Guide.mdx now, in full — not from memory. You will have drifted from at least one rule while drafting.title plus a single-sentence excerpt; never a description field.--- horizontal rule.**Grant —** description).<Note>/<Warning>/<Tip> with the label and its colon bolded (**Note:**), and a blank line before the callout (except inside table cells).python3 scripts/pad_md_tables.py <file> to do this mechanically. Normalize any HTML tables (one tag per line, data rows in <tbody>)..mdx extension and no full URL.tools—such as); spaces only in the bolded-term list exception.DataSet, DataFlow, DataFusion, Beast Mode, Workbench; dashboard lowercase except at the start of a sentence or with a type; never "Page" (use "dashboard"). Verify any product term against the Domo-Specific Terms and Usage table.tag + verbatim Note for a whole-article beta; Badge + single verbatim Note for section-level).<Frame> with a native <img> and descriptive alt, no inline width/height; inline glyphs use the icon font or the inline <img> style; never <Frame> inside a table cell.A new article file does not appear on the site until it is registered in docs.json. As the final step, invoke the add-to-nav skill to place the article in the navigation — do not edit docs.json by hand:
s/article/Article-Title-Hereadd-to-nav surface the placement options and use AskUserQuestion to confirm the location with the user.After add-to-nav edits docs.json, confirm it is still valid JSON:
python3 -c "import json; json.load(open('docs.json')); print('docs.json is valid JSON')"
s/article/Article-Title-Here.mdx).docs.json navigation and state where it was placed.After delivering the output above, ask the user:
"Would you like to localize this article into Spanish, French, and German? (Note: Japanese localization is handled on a separate pipeline — no action needed there.)"
localize skill, passing the new article's file path as the argument.localize an article, translate an article into Spanish French German, localize release notes, translate release notes, translate KB article
update a KB article, rename a document, edit article content, update screenshots, swap screenshots, remove content, update file paths, cross-file updates, update steps in a process, combine articles, split an article, merge articles
Automate the connector PR/Jira review workflow: match open GitHub PRs to Jira tickets, check approval status, post follow-ups, merge, and close tickets. Use when Jared asks to review connector PRs, run the connector dashboard, follow up on stale tickets, merge a specific connector ticket, or when handling a publish or migration request from Arun.
Generate user-friendly release notes by diffing the latest git tag against the previous tag and summarizing the changes. Use when the user asks to "generate release notes", "write release notes for the latest release", "summarize the latest release", or similar. Saves a shareable MDX file to `releaseNotes/` and a sanitized external version to `releaseNotesExternal/`.
Revise the MDX content in the current branch's PR for Domo style guide compliance and MDX code conventions — then preview the diff before committing and pushing.
Regenerate Article-PM-Ownership-Reference.mdx after the squad CSV or article list changes