ファイル名
各アプリケーションが書き出すファイル（主にCSV、PDF）の名前のガイドラインです。 ファイル名のライティングは、基本的な考え方、用字用語に準拠します。 ファイル名特有の気をつけるべきポイントを記載しています。
基本的な考え方
例
人事評価機能の「評価の書き出しCSV」の場合：
{評価テンプレート名}_評価_YYYYMMDDHHMM.csv
解説
アプリケーションで書き出すファイルの名前は、ユーザーがファイルを開かなくても概要が把握できる必要最低限の情報を記載します。
要素の記載順
ファイル名が長い場合は、ファイルの用途を踏まえて、ファイルを見分けやすくする情報から順に表示しましょう。
ファイルを一覧表示したときに、後半の文字が省略されるためです。
日時の表記
日時は、YYYYMMDDもしくは、YYYYMMDDHHMMと表記します。
日付と時間の間はつなげて表記します。ファイル名に _（アンダースコア） が多く挿入されるのを避けるためです。
秒は基本的に表記しません。ただし、秒までの表記が必要なプロダクトの場合は、秒まで含めてYYYYMMDDHHMMSSと表記します。
記号の扱い
_（アンダースコア）以外の記号は基本的に使用しません。
書き出し対象の名前や会社名に、ファイル名に使用できない記号が入っている場合は、詰めて表記します。
会社名の記載
会社名や「SmartHR」などの情報は、自明であるケースが多いので、基本的には記載しません。
ただし、会社情報の表記が必要なプロダクトの場合は、会社名を文頭に追加します。サブドメインは使用しません。
従業員の書類
例
社員番号101 管理花子さんの「2022年度条件通知書類」の場合：
101_管理花子_2022年度条件通知書類.pdf
解説
社員番号、氏名、書類名の順に並べ、間に_を入れます。
社内に同姓同名がいる場合も考えられるため、社員番号と氏名を併記し、間に_を入れます。
従業員名の表記
従業員の名前は、氏名とつなげて表記します。
書類名の表記
日本語で表記します。 アプリケーション内で設定した書類名に年度などが記載されている場合は、そのまま使用します。
アプリケーション上のデータを書き出したファイル
例
人事評価機能の「評価の書き出しCSV」の場合：
{評価テンプレート名}_評価_YYYYMMDDHHMM.csv
解説
書き出し対象、日時の順に並べ、間に_を挿入します。
書き出し対象の表記
書き出し対象は日本語で表記します。何のファイルかを一目で判断しやすくするためです。
例えば、次の情報を記載します。
- 一覧の書き出しの場合、テーブルのタイトルを流用して
{テーブル名}一覧と表記します。 - 書き出し対象に名前がついている場合は、
{名前}と表記します。
名前に/区切りの日付が入っている場合は、/を省き、詰めて表記します。
書き出し対象のオブジェクト名だけでは区別がつかない場合
書き出し対象のオブジェクト名だけでは区別がつかない場合は、{カスタムオブジェクト名}を前に記載します。
例えば、人事評価機能であれば、「評価」という表記だけでは区別がつかないため、{評価テンプレート名}を前に記載します。
日時の扱い
アプリケーション内でユーザーが変更する頻度が高いデータの場合は、ファイルの作成日時を記載します。
例えば、配置プロジェクトを書き出す場合、書き出した日時以降にユーザーが配置を変更する可能性があるため、ファイルの作成日時を記載します。
ある時点のデータの場合は、その時点の日時を記載します。
例えば、ある時点の組織図・名簿を書き出す場合は、その時点の日時を記載します。
書き出し対象の名前に、時点に関する表記が含まれている場合は、日時を記載する必要はありません。
設定用ファイル
設定用ファイルとは、アプリケーション上に取り込んで、設定や更新操作にのみ使用するファイルのことです。
一部、書き出しファイルを設定用ファイルとして使用する場合もあります。
テンプレートとして使用するサンプルファイルも、設定用ファイルとして扱います。
例
人事評価機能の「評価者一括設定用ファイル」の場合：
評価者評価共有者設定_{YYYYMMDDHHMM}_{評価プロジェクト名}.csv
解説
用途、日時の順に並べ、間に_を挿入します。
用途の表記
用途、もしくは設定・更新対象は、日本語で表記します。
用途とは、設定ファイルで設定する内容のことです。ユーザーにとって最も大事な情報なため、最初に記載します。
用途だけでは区別がつかない場合
用途だけでは区別がつかない場合は、{カスタムオブジェクト名}を最後に記載します。
例えば、人事評価機能であれば、「評価者評価共有者設定」という表記だけでは区別がつかないため、{評価プロジェクト名}を最後に記載します。
日時の表記
ファイルの作成日時を記載します。 アプリケーション内のデータ更新に使用するケースが多いため、日時はなるべく記載しましょう。