Skip to content

README_en.md

Latest commit

 

History

History
131 lines (80 loc) · 3.33 KB

README_en.md

File metadata and controls

131 lines (80 loc) · 3.33 KB
Raw

English 日本語

✅ Introduction

This repository provides a collection of skills for creating technical articles in Qiita format from the information you provide.

✅ How to Use

Prerequisites

These skills are designed for generating articles with AI using GitHub Copilot or Codex.
They may not work as expected in other environments.

When using Codex, the workflow can also generate and embed explanatory diagrams in the article.
Copyright compliance is not currently guaranteed, so you must always review generated articles yourself before publishing them.

1. Clone this repository

2. Organize your source material

Provide technical information as text or a URL to the appropriate skill below. The skill will organize the information and save the results to a local folder.

  • GitHub Copilot
01_ArticleOrganization
  • Codex
01_元ネタ情報整理

3. Create a draft article outline

Run the appropriate skill below to generate a proposed section structure.

  • GitHub Copilot
/02_ArticleSectionCreation
  • Codex
/02_セクション素案生成

4. Generate explanatory diagrams (Codex only)

  • Codex
03_記事図解生成

This step creates original diagrams for the article from facts organized as text. It does not reproduce, modify, trace, or imitate images from the source material.

5. Create the technical article

Provide your desired article length to the appropriate skill below, then run it to generate the article.

  • GitHub Copilot
/03_ArticleCreation
  • Codex
/04_テック記事作成

As current AI models are increasingly capable, the article should already be highly polished by this stage.

6. Review the article

Run the appropriate skill below to review the generated article.

  • GitHub Copilot
/04_ArticleReview
  • Codex
/05_記事レビュー

✅ Defining Your Writing Style and Tone

A custom prompt for extracting writing style and tone is currently planned. Until it is available, use the following process:

1. Ask ChatGPT to extract the style and tone

The free ChatGPT plan is sufficient. Provide the URL of an article whose style you want to reproduce, along with a prompt such as:

From the article at the URL below, extract the writing style and tone as a set of
rules in Markdown format that an AI can follow when writing future articles.

https://qiita.com/ochtum/items/750413e44b0d296387ef

2. Save the extracted style and tone

Paste the extracted content into .specify\memory\文体・トーン-constitution.md.

✅ Changing the Output Format

To use a format other than Qiita, edit templates\記事作成-template.md.

✅ Customizing the Article Design

The article design rules are defined in .specify\memory\文体・トーン-constitution.md, from the "Section Design Rules" section through the "Clearly Present Procedures, Notes, and Tips" section.
Edit these rules to customize the design of generated articles.

❗ License

This project is provided under the MIT License. See the LICENSE file for details.