Skip to content
cccskills
FreePublished on GitHub

maka-architecture-docs

Create, rewrite, translate, or review Chinese and English architecture documentation for the Maka Agent backend. It helps explain system behavior with evidence, preserve technical meaning across languages, and identify gaps in clarity, accuracy, and maintainability.

OriginalShow the original description

Draft, restructure, translate, or review bilingual Chinese-English architecture documentation for the Maka Agent backend. Use when Codex works on Maka technical narratives, component or mechanism explanations, architecture decisions, system flows, engineering guides, or documentation quality checks and needs blog-like clarity without losing architectural precision. Do not use it to impose a fixed topic list or information architecture unless the user asks for one.

apache/maka5,927 stars(GitHub 5,927 + cccskills 0)

Run score Not tested

See how to install

Good for

  • Drafting an architecture article from code and design notes
  • Rewriting an existing technical document for clarity
  • Creating a natural Chinese or English counterpart
  • Reviewing factual accuracy and bilingual consistency

Files included (6)

  • SKILL.md5.6 KB
  • agents/openai.yaml1.0 KB
  • assets/article-template.md2.7 KB
  • references/bilingual-standard.md4.3 KB
  • references/quality-gate.md3.6 KB
  • references/writing-standard.md6.3 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

<!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -->

Maka Architecture Docs

Create architecture documentation that is easy to enter, technically rigorous, and maintainable in both Chinese and English. Treat the user's chosen subject and document organization as constraints; this skill governs writing quality, evidence, bilingual consistency, and review.

Select the task mode

  • Draft: create a new document from code, design notes, interviews, or a user brief.
  • Rewrite: improve an existing document while preserving its technical meaning.
  • Translate: produce a natural counterpart in the other language, not a sentence-by-sentence transliteration.
  • Review: identify concrete gaps in clarity, evidence, correctness, or bilingual consistency.
  • Standardize: align multiple documents on terminology, metadata, status labels, and structure without forcing them into identical narratives.

Confirm the intended mode from the request. Infer it when safe; ask only when different interpretations would materially change the output.

Follow the workflow

  1. Establish the article contract. State the one core question, intended reader, expected reading depth, source language, and claimed implementation status. Do not invent a topic or replace the user's outline.
  2. Collect evidence. Inspect the relevant code paths, tests, schemas, configuration, ADRs, and existing documents before presenting implementation details as facts. Separate verified behavior from plans and interpretation.
  3. Build the narrative. Move from problem and intuition to a concrete scenario, then mechanism, boundaries, failures, and trade-offs. Include only the sections that help answer the core question.
  4. Add technical anchors. Connect claims to real components, state transitions, invariants, interfaces, observability signals, or code locations as appropriate.
  5. Create the bilingual counterpart. Preserve concepts, status, examples, diagrams, and section identity while rewriting naturally for the target language.
  6. Run the quality gate. Review both language versions against references/quality-gate.md. Fix failed required checks before calling the document complete.

Read references/writing-standard.md whenever drafting, rewriting, or standardizing architecture content. Read references/bilingual-standard.md whenever creating or reviewing both languages. Use assets/article-template.md as a starting scaffold only when it fits the chosen subject; remove irrelevant sections rather than filling them mechanically.

Apply non-negotiable rules

  • Start from a reader question or engineering problem, not a component inventory.
  • Distinguish Current, Planned, Exploratory, Deprecated, and Historical claims.
  • Never present an unverified design assumption as current implementation.
  • Explain important mechanisms through intuition, scenario, mechanism, and boundary.
  • Cover meaningful failure paths and trade-offs, not only the happy path.
  • Keep diagrams purposeful and language-neutral where practical; explain what each diagram includes and omits.
  • Use stable terms. Do not alternate among synonyms for variety when they represent the same Maka concept.
  • Prefer separate, complete Chinese and English documents with shared assets over interleaved paragraph-by-paragraph translation.
  • Preserve uncertainty. Translation must not strengthen or weaken a claim.
  • Optimize for progressive depth: a reader should gain value from the opening summary without reading the entire article.

Handle reviews

Lead with actionable findings ordered by impact. Cite the exact section or line when possible. Check, in order:

  1. factual correctness and status confusion;
  2. missing boundaries, invariants, or failure behavior;
  3. broken narrative or unexplained concepts;
  4. bilingual semantic drift and terminology inconsistency;
  5. maintainability issues such as duplicated diagrams or unstable code references;
  6. style polish.

If there are no material findings, say so and identify any verification limits.

Deliver artifacts

When creating files, follow the repository's existing documentation layout. If no convention exists, recommend rather than silently establish a new repository-wide structure. Keep language counterparts at matching relative paths or give them stable shared document IDs. Report which technical claims were verified and which remain planned or uncertain.

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

code-review

FreeSummary

Review pull requests and code changes against the problem they claim to solve. Check correctness, root cause, unnecessary complexity, deletable code, test quality, maintainability, and merge readiness, with findings tied to specific locations and concrete failure modes.

  • Checking whether a patch fixes the root cause
  • Finding unnecessary code or duplicate logic
  • Assessing whether tests protect intended behavior
apache/maka5.9KUpdated Oct 29, 2026

Computer Use

FreeSummary

Inspect and operate local desktop application interfaces by reading windows, clicking controls, entering values, using menus, and scrolling. Verify the visible result after each action, and use this skill when a task requires the real app UI.

  • Reading the current desktop app window
  • Filling a form or selecting a menu item
  • Scrolling a list or handling a dialog
apache/maka5.9KUpdated Oct 29, 2026

maka-cli

FreeSummary

Coordinate tasks through Maka CLI by submitting work, waiting for results, checking session progress, and adding follow-up prompts. Handle worker questions and approval requests, and update saved session models or settings when needed.

  • Submitting a task and collecting its result
  • Checking progress in a Maka session
  • Answering a worker's question or approval request
apache/maka5.9KUpdated Oct 29, 2026

See all skills by apache

Report a problem with this skill