Changes
4 changed files (+126/-0)
-
-
@@ -19,6 +19,8 @@ use_directory_urls: falsenav: - index.md - about.md - file-types.md - 仕様: - spec/files.md - spec/provision-table.md
-
@@ -51,7 +53,10 @@ slugify: !!python/object/apply:pymdownx.slugs.slugifykwds: case: lower - admonition - abbr - footnotes - pymdownx.superfences: preserve_tabs: true - pymdownx.tabbed: alternate_style: true - pymdownx.keys
-
-
docs/src/about.md (new)
-
@@ -0,0 +1,54 @@# Yamori について <!-- SPDX-License-Identifier: AGPL-3.0-only Copyright 2025 Shota FUJI This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. You should have received a copy of the GNU Affero General Public License along with this program. If not, see <http://www.gnu.org/licenses/>. --> Yamori は年次有給休暇の計算と検証、可視化を行うオープンソース[^0]ソフトウェアです。 勤怠が記録されたファイルや社員データファイルを読み込み、年次有給休暇を何日取得したか、何日残っているか、出勤率が八割を下回っていないかなどを自動で計算します。 [^0]: [AGPL 3.0](https://www.gnu.org/licenses/agpl-3.0.ja.html) でライセンスされています。 ## 特徴 一般的な勤怠システム・ソフトウェアと異なり、Yamori は入力インターフェイスを持っていません。 社員の名前や ID 、初回付与日、勤怠といった「事実」や「記録」は全てユーザがファイルに入力します。 そのため、ファイルの書式はユーザがそのまま見てもわかりやすいものとなっており、Yamori 以外の外部プログラムからのアクセスも容易です。 !!! info "ファイルの種類" 利用可能なファイルの種類は[ファイル形式](./file-types.md)ページにまとまっています。 Yamori を起動すると、ユーザが入力した「事実」や「記録」を全て読み込み、年次有給休暇の取得日数や法令違反のリスクといった「集計」や集計に基づく「状況」を表示します。 ユーザデータが通常の一般ファイルであるためベンダーロックインが発生せず、移行や連携がしやすいのが大きな特徴となります。 また、ソースコードが公開されていることに加えネットワーク通信が不要[^1]なことから、セキュリティ上のリスクはクラウドサービスと比べて圧倒的に低くなります。 [^1]: Yamori はローカルソフトウェアです。インターネットや LAN がない状況でも完全に機能します。 ## 利用方法 Yamori のデスクトップアプリケーションをダウンロードし実行します。 サポートされる OS は以下のとおりです。 - macOS Catalina 10.15 以降 - Windows 10, 11 - Linux !!! note "準備中" ダウンロードページは現在準備中です。
-
-
docs/src/file-types.md (new)
-
@@ -0,0 +1,65 @@# ファイル形式 <!-- SPDX-License-Identifier: AGPL-3.0-only Copyright 2025 Shota FUJI This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. You should have received a copy of the GNU Affero General Public License along with this program. If not, see <http://www.gnu.org/licenses/>. --> Yamori では以下の形式のファイルが利用できます。 - [Excel ワークブック](#excel-ワークブック) - [CSV](#csv) - [TSV](#tsv) ファイル内の構造やファイル名が仕様に沿っている限り、どのデータにどのファイル形式を利用するのかは自由です。 ## Excel ワークブック Microsoft Excel のワークブック (`.xlsx`) です。 シート単位で読み込むため、一つのワークブックに複数のデータを含めることも可能です。 （例: 社員マスタと勤怠記録を同じワークブックで管理する） !!! note "確認中" どの Excel バージョンのワークブックまで読み込めるかは現在確認中です。 ## CSV カンマ (`,`) で列を区切り、改行 (CR+LF) で行が区切られたテキストファイルです。 文字コードは UTF-8 のみサポートしています。 **最初のヘッダ行は必須です**。 CSV に対応したソフトウェア・システムと連携させる場合に便利です。 ファイルは[RFC 4180](https://www.rfc-editor.org/rfc/rfc4180)に準拠している必要があります。 (`text/csv;charset=utf-8`) *[CSV]: Comma-Separated Values ## TSV タブ文字 ( ++tab++ で入力できる空白文字)で列を区切り、改行 (LFまたはCR+LF) で行が区切られたテキストファイルです。 文字コードは UTF-8 のみサポートしています。 Yamori のデータファイルを読み込むプログラムを書く場合に便利です。 ファイルは [IANA に登録されている定義](https://www.iana.org/assignments/media-types/text/tab-separated-values)に準拠している必要があります。 (`text/tab-separated-values;charset=utf-8`) *[TSV]: Tab-Separated Values ## 将来サポート予定のファイル形式 - マクロ有効 Excel ワークブック (`.xlsm`) - JSON (`.json`, `.jsonc`)
-
-
-
@@ -18,5 +18,7 @@ -->このドキュメントは年次有給休暇計算ソフトウェア "Yamori" の取り扱い説明書です。 - [Yamori について](./about.md) - [ファイル形式](./file-types.md) - [仕様](./spec/files.md) - [ソースコード](https://git.pocka.jp/yamori.git/tree/master/)
-