Asking for Feedback on Your Documentation

8/5/2026beginner

Speakers

You

あなた

Aoife

AIエンジニア（アイルランド）

この場面について

自分が書いたREADME（ドキュメント）について、海外のAIエンジニアの同僚にフィードバックをお願いする場面。

Summary (JP)

あなたは新しいAPIのREADMEを書き終え、アイルランド出身の同僚Aoifeにチェックをお願いします。Aoifeは内容は分かりやすいと褒めつつ、インストール手順が少し分かりにくいことと、コード例を追加した方がいいことを指摘します。さらに文章中のタイプミスも見つけてくれて、あなたはそれぞれを直すと約束します。

会話

Speed:

文をクリックすると、その部分から読み上げが始まります。

You:

Hi Aoife! Do you have a minute? I just finished the README for the new API.

Aoife:

Sure, no problem! Send me the link, and I'll take a look.

You:

Thanks so much! Here's the link. It explains how to set up the project.

Aoife:

Okay, I'm reading it now. This looks really clear. Great job!

You:

Thank you! Is anything confusing? I want it to be easy for new users.

Aoife:

One thing. The installation steps are a bit unclear.

You:

Oh, really? Can you tell me more? I'll fix that part.

Aoife:

You should add a code example for step three.

You:

That's a good idea. I'll add an example right now.

Aoife:

Also, check your spelling in the second paragraph.

You:

Good catch! I'll fix the typo. Thanks for your help.

Aoife:

No problem! Send it to me again when you're done.

Vocabulary

Do you have a minute?

Meaning: ちょっと時間ある?（軽く声をかけるときの表現）

Example: Do you have a minute to check this?

take a look

Meaning: ちょっと見る、確認する

Example: Can you take a look at my code?

set up

Meaning: セットアップする、準備する

Example: I need to set up my laptop.

installation steps

Meaning: インストール手順

Example: The installation steps are easy to follow.

code example

Meaning: コード例

Example: Please add a code example here.

good catch

Meaning: よく気づいたね（ナイスチェックの意味）

Example: Good catch! I missed that typo.

typo

Meaning: タイプミス、誤字

Example: There is a typo in the title.

Quiz

1. What did You ask Aoife to review?

2. What did Aoife say was a bit unclear?

3. What did Aoife suggest adding?

4. Where did Aoife find a typo?

5. What does Aoife want You to do when the changes are done?

← Back to conversations