openlark-design-review
CommunitySystematic design and public API review
Software Engineering#api design#rust#design review#code audit#public api#feature gating#crate review
Authorfoxzool
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill turns ad-hoc, opinionated design feedback into a repeatable, evidence-backed design and public API audit for OpenLark crates and modules, reducing ambiguity around entry points, feature gating, execution patterns, and compatibility risk.
Core Features & Use Cases
- Checklist-driven audit for public API entry design, re-exports, Builder/Request/Service consistency, endpoint scheme, config lifecycle, error handling, and testing/warning control.
- Quantified API completion metrics that exclude deprecated meta.Version=old entries and produce per-bizTag and per-crate completion tables.
- Prioritized remediation output with P0–P3 issues, precise path:line evidence, a single selected convergence pattern (A or B), migration steps and <=10 executable TODOs.
- Use cases: crate-level design review, cross-crate convergence before release, strategic breaking-change planning, and sprintable refactor planning.
Quick Start
Run a design review on the target crate (for example crates/openlark-docs) and return a conclusion overview, API completion table, prioritized issue list with path:line evidence, a chosen convergence scheme, and an executable P0–P3 TODO list.
Dependency Matrix
Required Modules
None requiredComponents
references
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: openlark-design-review Download link: https://github.com/foxzool/open-lark/archive/main.zip#openlark-design-review Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.