writing-introductory-descriptions

name	writing-introductory-descriptions
description	Use when needing to explain technical systems, modules, or features in plain language for introductory articles or non-technical readers. Use when asked to summarize using "大白话" (plain language).

Writing Introductory Descriptions

Overview

Transforming complex technical implementations into intuitive, player-centric plain language explanations (大白话) tailored for introductory articles.

When to Use

• When writing feature introductions for articles, blogs, or READMEs.
• When explaining how a system works to a non-technical audience (players, users).
• When summarizing code logic into core "what the user experiences" concepts.
• When the prompt specifically asks for "大白话" (plain language/layman's terms) or player-facing descriptions.
• When you need to bridge the gap between technical architecture and user experience.

Core Pattern

Focus on the user's experience, senses, and actions rather than the underlying code architecture. Translate technical components into their human-understandable equivalents.

The system uses a raycaster to find instances, then passes the hit normal to the chunk manager to calculate the `worldBlock` array index for placement. 你只需要将准星对准想要的方块表面，点击右键，新方块就会自然地“贴”上去。

Reference Mapping

Technical Concept	Plain Language Equivalent
Raycaster / Raycast	视线锁定、准星对准、目光聚焦
Event Bus / Emitter	系统自动同步、后台无缝联动
Progress / Tick	进度环、读条、持续时间
Voxel / Chunk Data	整个方块世界、广阔天地
Instantiate / Spawn	放置、生成、出现
Destroy / Unmount	敲碎、破坏、移除

Implementation Steps

1. Engaging Title: Use visual Emojis + Core Feature Name (e.g., 🧱 灵活的挖掘与放置系统).
2. Contextual Intro: One sentence setting the stage of what this feature does overall from the user's perspective.
3. Numbered Steps (Focusing on flow):
   • Step 1 (Intent & Targeting): How the user indicates intent (e.g., looking at something, aiming the crosshair).
   • Step 2 (Action & Feedback): The interaction (holding click, pressing a key) and the immediate feedback (highlight, progress bar).
   • Step 3 (Result & Consequence): The final outcome (block placed, resources consumed, inventory updated).
4. Summary: A brief concluding sentence emphasizing the feeling or experience (e.g., "沉浸感", "真实的创造体验").

Quick Reference Checklist

• Are technical terms (Manager, Raycaster, Array, Event Bus) completely removed?
• Are verbs focused on human actions (看向, 点击, 长按)?
• Are emojis used to break up text and make it friendly?
• Is there an analogy comparing the feature to an everyday concept?

Common Mistakes

• Leaking architecture: Mentioning internal variable names or design patterns (e.g., "单向数据流") in the plain language version.
• Overly abstract: Being so high-level that it doesn't describe what the user actually does (e.g., "系统会处理你的输入并改变世界" instead of "你长按鼠标就能改变世界").
• Mechanical tone: Using dry, manual-like language instead of an enthusiastic, conversational, and direct tone.