How to Improve Technical Articles Using ChatGPT

Introduction

In this article, I will introduce how to use ChatGPT^[1] to improve the quality of technical articles. By refining ChatGPT's prompts^[2], it can review your articles and point out issues or areas for improvement. This time, I will introduce how to fully utilize this feature to enhance the quality of technical blog posts.

How to Review Blog Posts Using ChatGPT

By adding a specific role to your ChatGPT prompt, it will respond in accordance with that role. In this article, we give ChatGPT the role of an "editor" to review blog posts. Furthermore, by specifying a clear theme and target audience, the feedback becomes more concrete and accurate.

How to Create Prompts That Turn ChatGPT into a Top-Tier Editor

When asking ChatGPT a question, giving it the role of a "top-tier editor" in the prompt allows it to respond like an editor. Additionally, providing supplementary information such as the theme and target audience makes the response even more effective.

By crafting your prompts, you can make ChatGPT work as a top-tier editor. I have posted the prompt on GitHub Gist. The content of the prompt is:

This prompt is designed to interpret the text following "text" as an article and point out areas for improvement.

How to Improve Articles Using ChatGPT

We will look at each draft and its improvement points for the article "Genie AI is out, so I had AI write a Zenn article".
The manuscripts are available on GitHub Gist.

To improve an article, paste the prompt into ChatGPT, followed by the part of the article you want to refine.
When you press Enter to submit it to ChatGPT, it will point out areas for improvement.

Workflow for Improving Articles Using ChatGPT

The flow for reviewing and refining an article using ChatGPT is as follows:

1. Open the ChatGPT website: https://chat.openai.com/chat

2. Paste the prompt and the manuscript into the text area and press [[Enter:]]

3. ChatGPT will present improvements and alternatives

4. Rewrite the manuscript based on the suggested improvements and alternatives

5. Repeat steps 2-4.

This is the process.

Article Example (First Draft)

Let's look at the points for improvement in the first draft.
The first draft is as follows.

We will review this using the prompt we created.

Review of the First Draft and Resulting Improvements

The results of the review are as follows.

1st Review and Refinement:

This article introduces how programmers write blog posts using VS Code extensions with a tool called Genie AI. However, the article is difficult to read and has some hard-to-understand parts, so there is room for improvement. Specifically, the following points can be raised:

• The title's emoji (👟) and type (Idea) are inappropriate, making the intent of the heading unclear.
• The reason why VS Code is attracting attention is not clear in the introduction, and an explanation of what Genie AI is is also missing.
• The sections are not in an appropriate order, making it unclear in what sequence they should be read.
• Due to insufficient explanation, the functions of Genie AI are difficult to understand.
• The method for referencing information on the web is not explained, which may lead to confusion.

Based on these points, alternatives are provided below:

• Review the title to make the purpose of the article clear.
• In the introduction, explain in detail why VS Code is attracting attention and provide an explanation of Genie AI.
• Arrange sections in order to structure the text logically.
• Explain the functions of Genie AI in detail.
• Explain how to reference information on the web.

Improvements and Alternatives

1. Change the title's emoji and type

   • Example: "How to Efficiently Write Blog Posts in VS Code Using Genie AI"

2. Add the following points to the introduction

   • Explain why VS Code is attracting attention and why developers use this editor.
   • Explain Genie AI. Describe what ChatGPT is and how Genie AI assists programmers.

3. Reorder the sections as follows

   1. What is Genie AI?
   2. How to write blog posts with Genie AI
   3. How to reference information on the web

4. Explain the functions of Genie AI in detail

   • List the functions as bullet points.

While some suggestions are off-target, it points out improvements in detail.
I will rewrite the first draft referring to these points.

Article Example (3rd Draft)

I rewrote the manuscript based on the improvements and review of the first draft. The following is the resulting third draft.

Improvements for the 3rd Draft

Just as with the first draft, I had ChatGPT review it. The improvements that emerged are as follows:

1st Review/Refinement

Role: Top-tier Editor

Improvements:

• Need to check if the title is appropriate
• Lacks explanations that the reader can understand immediately
• Follows the theme, but more specific content is desired

Alternatives:

• Make the title clearer to make the article content easier to understand
• Add explanations to specifically describe what Genie AI is and what will be done in the article
• Provide specific examples to show how programmers using Genie AI are writing articles

Improvements and Alternatives:

• Clarify the title
• Explain what Genie AI is
• Show specific examples of how to write a blog using Genie AI

2nd Review/Refinement

Role: Skilled Proofreader

Improvements:

• The structure of the article is hard to understand
• The article as a whole feels redundant
• Because the article is long, headings are needed

Alternatives:

• Summarize the article concisely
• Add headings to make the article easier to read
• Clarify the structure of the article so readers can easily understand the flow

Improvements and Alternatives:

• Add headings to clarify the structure of the article
• Summarize the article concisely
• Clarify the content of each section to make it easier for readers to understand the flow of the article

3rd Review/Refinement

Role: Fact-checking Proofreader

Improvements:

• The content of the article lacks depth
• Detailed explanation of Genie AI is necessary

Alternatives:

• Add detailed information about Genie AI
• Show the pros and cons of Genie AI
• Explain the results obtained by using Genie AI

The improvements for the 3rd draft were as shown above. While criticisms regarding expressions like emojis have almost disappeared, criticisms regarding the quality of the writing—such as the title being inappropriate or the article lacking depth—have increased. Based on these, I will further improve the text.

Article Example (4th Draft)

I have further improved the manuscript based on the improvements and alternatives suggested for the 3rd draft. Below is the 4th version of the manuscript.

Improvements for the 4th Draft

As with the first and third drafts, I will review the 4th draft using ChatGPT. The improvements are as follows:

1st Review and Refinement

Role of the Top-tier Editor:

This article introduces how programmers can efficiently write blog posts using Genie AI. The introduction touches on new technology and highlights that Genie AI, a VS Code extension, is attracting attention. Furthermore, Genie AI is explained concisely and clearly, making it understandable even for readers learning about it for the first time. However, the introduction does not mention how programmers can specifically write blog posts efficiently in this article, and more specific explanations are needed.

Role of the Skilled Proofreader:

This article provides a detailed explanation of the main topic: how to efficiently write blog posts using Genie AI. It introduces prompts that programmers can use and explains how the Editor View feature of Genie AI helps in writing smoothly. However, since the specific method of writing efficiently using the Editor View is not explained in detail, readers may need to look for other sources to fully master this feature.

Role of the Fact-checking Proofreader:

This article explains how to efficiently write blog posts using Genie AI. The prompts used by programmers are appropriately introduced, and the explanation of the Editor View feature is concise and clear. However, there are few parts where the functions of Genie AI are explained in detail, so there is a possibility that readers will need additional information sources to understand and master this tool.

It seems the quality of the manuscript has improved considerably. The text follows the theme and seems fine. However, it was pointed out that some explanations are still insufficient.

Based on these points, I will polish the manuscript further. As a result, the next article "Prompts to make Genie AI write articles at a publishable level" was created.

Conclusion

In this article, I practiced the method of reviewing and refining blog posts using ChatGPT. As you can see from this article, by having ChatGPT provide feedback, anyone can write high-quality blog posts. It’s a new technology well worth trying out.

Well then, Happy Hacking!

References

• GitHub Gist
• ChatGPT

脚注

1. ChatGPT is a chatbot that utilizes a large-scale natural language processing model developed by OpenAI.

2. This refers to the questions entered into ChatGPT.