design-doc

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Design Doc

设计文档

This skill is for when you're asked to write a design document or design specification, especially after a brainstorm or feature design session.
Design docs go into the
docs/
directory in the project root. Create the folder if it doesn't exist. The design doc is in Markdown. Choose a concise, relevant name yourself.
本技能适用于需要撰写设计文档或设计规格说明书的场景,尤其是在头脑风暴或功能设计会议之后。
设计文档需放置在项目根目录下的
docs/
文件夹中。若该文件夹不存在,请创建它。 设计文档采用Markdown格式。请自行选择一个简洁且相关的文件名。

Content

内容要求

  • Be concise.
  • Don't include too many code examples, unless necessary because they contain valuable details uncovered during the brainstorm or design session.
  • 简洁明了。
  • 除非头脑风暴或设计会议中发现的重要细节必须通过代码示例体现,否则请勿包含过多代码示例。