Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

操作手順でクリックする対象を続けて書く定型文を統一する #1491

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

操作手順でクリックする対象を続けて書く定型文を統一する #1491

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ed8e3c9
手順を示す「>」の前後では、半角スペースなしにする
azusa-harashima Jan 17, 2025
c62ca00
操作手順の案内に使う「>」は半角に使うことを記載
azusa-harashima Jan 17, 2025
e964230
操作手順に使う「>」の扱いを明示
azusa-harashima Jan 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions src/content/articles/products/contents/help-center/step-by-step.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,22 +116,26 @@ Tipsとして扱うのは、ユーザーが読み飛ばしても、操作を完
| -------- | -------- | -------- | -------- |
| 1 | ユーザーがやりたいこと（タイトル） | XXを管理する | XXを作成する |
| 2 | ユーザーがやりたいことをアプリケーション上の言葉で言い直す（リード文） | XXのXXを設定する手順を説明します。 | XXで、XXしたいXXをXXする手順を説明します。 |
| 3 | 操作手順の要約（見出し1） | 1. XX画面で［XX］を押す／2. ［XX］ > ［XX］を選択／3. XX画面でXXを確認／補足事項 | XXについて／1. ［XX］メニューで［XX］を選択／2. XX画面で［XX］を押す |
| 3 | 操作手順の要約（見出し1） | 1. XX画面で［XX］を押す／2. ［XX］>［XX］を選択／3. XX画面でXXを確認／補足事項 | XXについて／1. ［XX］メニューで［XX］を選択／2. XX画面で［XX］を押す |
| 4 | 操作手順の詳細（本文） | XX画面で［XX］を押します。XXのメニューが表示されます。 | ［XX］メニューで［XX］を選択すると、XX画面が表示されます。 |

操作手順の案内に使う`>`は半角を使用します。

#### 記載例
[組織図または名簿形式のCSVファイルをダウンロードする](https://support.smarthr.jp/ja/help/articles/4411586712985)

{<span id="multiple-operations-pattern" />}
### 複数の操作のライティングパターン

| # | 内容 | 例 |
| # | 内容 | 例 |
| -------- | -------- | -------- |
| 1 | ユーザーがやりたいこと（タイトル） | XXを編集する |
| 2 | ユーザーがやりたいことをアプリケーション上の言葉で言い直す（リード文） | XXのXXを更新、追加、削除する手順を説明します。 |
| 3 | 個別の操作でユーザーがやりたいこと（見出し1） | XXとは／XXを更新する／XXを追加する／XXを削除する |
| 4 | 操作手順の要約（見出し2） | 1. XX画面で［XX］を押す／2. ［XX］ > ［XX］を選択 |
| 4 | 操作手順の要約（見出し2） | 1. XX画面で［XX］を押す／2. ［XX］>［XX］を選択 |
| 5 | 操作手順の詳細（本文） | XX画面で［XX］を押すと、XXされます。 |

操作手順の案内に使う`>`は半角を使用します。

#### 記載例
[評価テンプレートを管理する](https://support.smarthr.jp/ja/help/articles/4407070408473)
14 changes: 9 additions & 5 deletions src/content/articles/products/contents/idiomatic-usage/symbol.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,13 +72,17 @@ NG：2020 年の年末調整
記述記号は基本的に全角を使用し記号の前後にスペースは挿入しません。英数字とあわせて表記する場合のみ半角を使用します。

記述記号とは、以下を指します。
- 区切り符　`・`（中点、ナカグロ）、`｜`（バーティカルバー、パイプ）、`：`（コロン）、`／`（スラッシュ）
- 句読点　`、`（読点）、`。`（句点）
- 括弧類　`（ ）`、`「 」` 、`［ ］`、`【 】`
- つなぎ符　`― `（ダッシュ）、`…`（三点リーダー）、`〜`（波線）
- **区切り符**　`・`（中点、ナカグロ）、`｜`（バーティカルバー、パイプ）、`：`（コロン）、`／`（スラッシュ）
- **句読点**　`、`（読点）、`。`（句点）
- **括弧類**　`（ ）`、`「 」` 、`［ ］`、`【 】`
- **つなぎ符**　`― `（ダッシュ）、`…`（三点リーダー）、`〜`（波線）
- `？`（疑問符）、`！`（感嘆符）

例外として、**数値の3桁ごとに使用するカンマ（ , ）、階層構造を表す際の区切り符（ / ，>）、変数を表す波括弧（\{ \}）は半角**を使用します。
例外として、以下の記号は**半角**を使用します。
- 数値の3桁ごとに使用するカンマ（`,`）
- 階層構造を表す際の区切り符（`/`，`>`）
- 変数を表す波括弧（`{ }`）
- 操作手順の案内に使う区切り符（`>`）

### 議事録
https://kufuinc.slack.com/archives/CJX59GJFR/p1643955700509219
Expand Down
Loading