Skip to content
Skills Library
Programming · Research

opensourcefaq

/opensourcefaq

Answer open-source product questions by combining local source-code and documentation research, project framework notes generated by init, DeepWiki repository knowledge, and current web evidence, then save a sourced, diagram-rich Markdown answer to the current project's markdown directory. Use when the user asks about behavior, architecture, internals, configuration, APIs, troubleshooting, performance, operations, extension points, practical reproduction, or version-specific details of one or more open-source projects and provides the question, all relevant local source directories, and DeepWi

Repository
blog ↗
Licence
LGPL
Last repository change
21.10.2026

Assessment and security

100/ 100Class: good
Format25 / 25
Frontmatter with name and description, valid name, description up to 1,024 characters, name matching the folder.
Discoverability25 / 25
Description explains when to use the skill, has a reasonable length and uses third person.
Content35 / 35
At least 150 words and at most 500 lines, headings, step lists, examples or code.
Hygiene15 / 15
No placeholders such as TODO, no Windows paths, with a licence.
Riskno signals detected in the scan
Files in this package
2
Scripts
0
HTML comments
0
URLs in SKILL.md
0
Deprecation

No signals detected. Repository changed on 21.10.2026, without references to retired models or APIs.

Licence

LGPL, otwarta.

What it does and when to use it

Answer open-source product questions by combining local source-code and documentation research, project framework notes generated by init, DeepWiki repository knowledge, and current web evidence, then save a sourced, diagram-rich Markdown answer to the current project's markdown directory. Use when the user asks about behavior, architecture, internals, configuration, APIs, troubleshooting, performance, operations, extension points, practical reproduction, or version-specific details of one or more open-source projects and provides the question, all relevant local source directories, and DeepWi

Original author description

Answer open-source product questions by combining local source-code and documentation research, project framework notes generated by init, DeepWiki repository knowledge, and current web evidence, then save a sourced, diagram-rich Markdown answer to the current project's markdown directory. Use when the user asks about behavior, architecture, internals, configuration, APIs, troubleshooting, performance, operations, extension points, practical reproduction, or version-specific details of one or more open-source projects and provides the question, all relevant local source directories, and DeepWi

How it works

  1. Overview
  2. Inputs
  3. Workflow
  4. Practical Reproduction Requirements
  5. Article Structure
  6. Validation Rules
Original SKILL.md headings · 130 lines, 1,111 words
SKILL.md preview
---
name: opensourcefaq
description: Answer open-source product questions by combining local source-code and documentation research, project framework notes generated by init, DeepWiki repository knowledge, and current web evidence, then save a sourced, diagram-rich Markdown answer to the current project's markdown directory. Use when the user asks about behavior, architecture, internals, configuration, APIs, troubleshooting, performance, operations, extension points, practical reproduction, or version-specific details of one or more open-source projects and provides the question, all relevant local source directories, and DeepWiki repoName values.
---

# Opensourcefaq

## Overview

Use this skill to produce a verified, source-backed, diagram-rich Markdown answer for questions about open-source products. Require the user to provide the question, every relevant project source directory, and the corresponding DeepWiki repoName values; remind them to clone the source first and run `init` to generate project framework notes before using the skill.

## Inputs

Confirm these inputs before writing the final article:

- `question`: the exact technical question to answer.
- `source_dirs`: absolute paths to all open-source project checkouts involved.
- `deepwiki_repo_names`: DeepWiki repoName values such as `owner/repo` for each relevant project.
- `version_context`: branch, tag, commit, release, or product version if the answer depends on version-specific behavior.

If any required input is missing, ask for it. If only the version context is missing, inspect the local checkout with `git -C <dir> rev-parse --abbrev-ref HEAD`, `git -C <dir> rev-parse HEAD`, and release files when useful, then state the inferred version and its limits.

## Workflow

1. Restate the question and scope.
   - Identify the involved projects, versions, modules, configuration, and runtime assumptions.
   - Split broad questions into concrete subquestions that can be checked against source code.

2. Analyze the problem.
   - Form hypotheses from the user's wording, known architecture, and likely code paths.
   - Name ambiguity early instead of silently choosing one interpretation.
   - Prefer the simplest explanation that source code and docs support.

3. Prepare evidence.
   - Search local source directories first with `rg`, `rg --files`, and targeted file reads.
   - Search both implementation code and project documentation relevant to the question. Include source files, tests, examples, SQL/API definitions, configuration templates, README/manual/reference docs, release notes, design docs, and migration notes when present.
   - When code and docs disagree, verify against the code path and note the documentation drift.
   - Read the project framework notes generated by `init` when present, then verify important claims against source files.
   - Browse DeepWiki project overviews for the listed repoName values.
   - Ask DeepWiki focused questions about architecture, relevant modules, and the exact technical behavior under investigation.
   - Search the web for relevant articles, issues, release notes, documentation, design docs, and discussions when current or external context matters.

4. Filter evidence quality.
   - Prefer source code, official docs, release notes, design docs, and maintainer comments.
   - Treat blogs, forum answers, and copied snippets as secondary evidence.
   - Check publication date, project version, branch, API names, file paths, and whether the behavior still exists in the local checkout.
   - Discard or clearly qualify outdated material.

5. Write the Markdown article.
   - Save under the current project's `markdown/` directory. Create that directory if it does not exist.
   - Use a clear filename derived from the question, for example `markdown/opensourcefaq-<topic>.md`.
   - Cite local files with paths and line numbers when possible.
   - Cite DeepWiki and web sources with links or repoName references.
   - Make the article diagram-rich. Include Mermaid diagrams for architecture, flow, sequence, state, dependency, data model, or query plans whenever they clarify the answer.
   - Add tables for evidence, version differences, tradeoffs, parameters, or operational checklists when useful.
   - If the user asks for practical execution, troubleshooting, benchmarking, reproduction, or "how to use", include a complete simulated environment and sample data generation method unless the real environment is already provided and sufficient.
   - Keep the article focused on the user's question; do not expand into an unrelated product overview.

6. Verify before finalizing.
   - Re-check every important technical claim against local code and DeepWiki.
   - Verify commands, configuration examples, API names, SQL, YAML, code snippets, and file paths.
   - If a claim cannot be verified, mark it as an inference and explain the basis.
   - If code behavior differs across versions, state exactly which version was verified and what may differ elsewhere.
   - For practical examples, verify that setup steps, generated data shape, commands, and expected outputs are internally consistent. If commands were not actually run, say so explicitly.

## Practical Reproduction Requirements

When the answer includes hands-on usage, troubleshooting, benchmarking, or an executable example, include:

- A minimal simulated environment: container commands, local build steps, package prerequisites, service configuration, database/schema setup, or equivalent project-native setup.
- Data generation: SQL, scripts, fixtures, API calls, or command sequences that create representative data covering normal cases and edge cases.
- Execution steps: commands or queries the reader can run in order.
- Expected observations: key outputs, metrics, query plans, logs, errors, or screenshots/diagrams to compare against.
- Cleanup steps when the setup creates services, containers, databases, files, or test data.

Prefer project-native tooling already present in the repository. Do not invent heavyweight infrastructure when a lightweight local or containerized setup demonstrates the point.

## Article Structure

Use this structure unless the user's question calls for a shorter answer:

```markdown
# <Question as a precise title>

## 问题描述
<Restate the question, scope, projects, and verified versions.>

## 结论先行
<Direct answer in a few paragraphs.>

## 问题分析
<Break down the reasoning path and key assumptions.>

## 准备素材
### 本地代码与文档搜索
<Important implementation files, tests, examples, docs, release notes, configs, functions, modules, and line references. State any mismatch between code and docs.>

### DeepWiki 综述与问答
<Relevant architecture summary and focused DeepWiki answers.>

### 网络资料筛选
<Current, high-quality external sources and rejected outdated sources when relevant.>

## 原理与实现细节
<Explain mechanisms, data flow, call flow, configuration, and edge cases.>

## 图解
<Mermaid architecture/flow/sequence/data-model diagrams and, when useful, tables that make the answer visually clear.>

## 实操示例
<If practical execution is relevant, provide simulated environment setup, sample data generation, executable commands, expected observations, and cleanup. Otherwise explain why no hands-on reproduction is needed.>

## 拓展思考
<How to generalize the method, compare adjacent designs, or avoid common mistakes.>

## 验证记录
<What was checked in source code, DeepWiki, tests, or commands, and any remaining uncertainty.>

## 参考资料
<Local paths, DeepWiki repoNames, and web URLs.>
```

## Validation Rules

- Do not rely on memory alone for product behavior.
- Do not cite web articles without checking version freshness and consistency with local source.
- Do not treat DeepWiki as final authority when local code contradicts it; source code wins.
- Do not invent line numbers, functions, flags, or configuration names.
- Do not omit related local documentation when searching source directories; code-only evidence is insufficient unless the project has no relevant docs.
- Do not output a text-only article when diagrams or tables would clarify the answer.
- Do not provide practical SQL/code/CLI examples without a reproducible environment and sample data plan, unless the user explicitly asks for conceptual explanation only.
- Keep final Markdown in Chinese by default unless the user asks for another language.
- End the response to the user with the saved file path and a concise verification summary.
Files in this package (2)
  • SKILL.md 8 KB
  • agents/openai.yaml 1 KB

Versions

RepositoryScoreLicence
This page · digoal/blog100LGPL
digoal/blog100LGPL

Database snapshot: 13.11.2026 · package version 7b6458786625 (SHA-256 digest of the entire package)

Downloads in the last 30 days: 0 · ranking

Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.

Similar skills

  • 100pgfaq
    Answer PostgreSQL core database questions by researching the local postgres source tree, PostgreSQL documentation under doc/src/sgml, relevant source code, and DeepWiki repository knowledge for postgres/postgres; use when the user asks any PostgreSQL database behavior,…
  • 100mcp-deepwiki
    This skill provides guidance for using DeepWiki MCP to explore GitHub repository documentation. Use when researching repository structure, understanding library APIs, asking questions about open-source projects, or exploring documentation for any GitHub repository.
  • 100deepwiki-api
    This skill enables GitHub repository documentation exploration using DeepWiki API directly via curl. Use when researching repository structure, understanding library APIs, or asking questions about open-source projects. MCP server not required.
  • 100open-source-project-article
    Analyze an open-source project from a repository URL and write a deeply sourced Chinese Markdown article. Use when the user asks to research a GitHub/open-source project, read its README, use DeepWiki MCP for architecture analysis, search related articles, compare competitors,…
  • 100researching-with-deepwiki
    Research GitHub, GitLab, and Bitbucket repositories using DeepWiki MCP server. Use when exploring unfamiliar codebases, understanding project architecture, or asking questions about how a specific open-source project works. Provides AI-powered repo analysis and RAG-based Q&A…
  • 100deepwiki-cli
    Use when the user asks questions about a GitHub repository's architecture, API, or internals, or mentions deepwiki-cli or DeepWiki. Activates when the user needs to understand a codebase they haven't cloned locally, or asks how a library or framework works. Do NOT activate for…

Feedback and reports

Your message goes to Bartosz Sokoliński. An email address is needed only for a reply. See the privacy policy.