技術寫作

來源狀態

可用來源

原始名稱: documentation-and-adrs

原始作者: Addy Osmani

這是第三方 Community Skill；2lus 收錄不代表已完整安全審計或保證安全。

資源類型

Skill

與類似 Skill 有什麼不同？

• 一手來源技術研究

  Technical Writing 將工程脈絡寫成 README、API 文件與 ADR；Primary Source Research 先查證資料與證據可信度。

來源描述的能力

這些是來源描述的可能操作，不代表 2lus 已授予權限或已測試。

尚未列出能力，請審查原始來源。

這個 Skill 是什麼？

把工程脈絡整理成可維護、可追溯的技術說明。

可以做什麼？何時適合使用？

• 補齊專案入門文件
• 記錄架構決策
• 更新公開 API 說明
• 建立使用者指南、教學、疑難排解、發行說明與交接 SOP

如何使用

1. 閱讀程式與現有文件慣例
2. 區分現況、決策與待確認資訊
3. 撰寫可引用來源的文件並檢查連結
4. 依讀者與任務選擇 README、教學、參考手冊或 SOP，再核對程式與操作步驟

使用前你需要準備

• 研究問題與讀者
• 可公開來源與版本範圍

你可以替換：

[topic]、[version]

環境與相依需求

• 提供可公開的原始碼與既有文件；保留來源共用 references。

使用範例與 Prompt

以下是 2lus 撰寫的示範需求；請替換為你有權處理的檔案與專案，不代表已執行或保證結果。

入門

依這份 package 設定整理 README 的 requirements 與 local setup，未知資訊明列待確認。

實務

為選擇 PostgreSQL 而非文件型資料庫撰寫 ADR，沿用現有格式，區分證據與假設。

進階

整理 architecture、deployment、troubleshooting 與操作交接索引，將 runbook 連回維運證據，標示未執行命令並校對 API 契約。

實用提醒

• 沿用既有 ADR 編號；記錄替代方案及取捨。
• 讓範例可複製，區分前置條件、操作步驟、預期結果與故障復原。

限制與注意事項

• 聚焦工程文件與 ADR，不是專門排版工具；不能捏造未執行的驗證。

安全注意事項

• 不得公開 secrets、內部位址或客戶資料；部署指令須標明影響。

使用與設定

此條目不提供已確認的通用安裝指令；請依官方文件與 Agent 版本操作。

支援平台

未確認特定 Agent 相容性

來源與授權

來源查核日期（非安全認證）: 2026-10-01

MIT

相關 Skills

• 一手來源技術研究
• DOCX Word 文件

Source status

Active source

Original name: documentation-and-adrs

Original author: Addy Osmani

This is a third-party community skill. Inclusion by 2lus is not a complete security audit or safety guarantee.

Resource type

Skill

How is this different from similar skills?

• Primary Source Research

  Technical Writing turns engineering context into READMEs, API docs and ADRs; Primary Source Research establishes evidence and source credibility.

Documented capabilities

These are operations described upstream, not permissions granted or tested by 2lus.

Capabilities not declared here; review the original source.

What is this skill?

Turn implementation context into maintainable, traceable technical writing.

Use cases and when to use it

• Improve project onboarding
• Record architecture decisions
• Update public API documentation
• Prepare user guides, tutorials, troubleshooting, release notes, and handoff SOPs

How to use it

1. Read code and existing conventions
2. Separate facts, decisions and unknowns
3. Draft source-linked documentation and review links
4. Choose README, tutorial, reference, or SOP by audience and task, then check steps against code

What you need

• Research question and audience
• Shareable sources and version scope

You can replace:

[topic], [version]

Environment and dependencies

• Provide shareable code and documentation; retain shared source references.

Usage and prompt examples

These example requests were written by 2lus. Substitute files and projects you may use; examples are not executed results or guarantees.

Beginner

Draft README requirements and local setup from this package configuration; mark unknowns explicitly.

Practical

Write an ADR comparing PostgreSQL with a document database using the established template and separating evidence from assumptions.

Advanced

Organize architecture, deployment, troubleshooting and handoff documentation; link runbooks to operational evidence and mark unexecuted commands.

Tips

• Continue existing ADR numbering and explain alternatives.
• Make examples reusable and distinguish prerequisites, steps, expected results, and recovery.

Limitations

• Focused on engineering documentation, not layout or invented verification results.

Security notes

• Exclude secrets, internal addresses and customer data; label deployment effects.

Usage and setup

No verified universal installation command is provided for this entry. Follow the official documentation for your agent version.

Supported agents

Specific agent compatibility unknown

Sources and license

Source check date (not a safety certification): 2026-10-01

MIT

Related skills

• Primary Source Research
• DOCX