{"id":26733485,"url":"https://github.com/ditig-com/naming-convention","last_synced_at":"2026-01-29T23:31:29.928Z","repository":{"id":263843406,"uuid":"884308756","full_name":"ditig-com/naming-convention","owner":"ditig-com","description":"File naming convention for efficient document filing.","archived":false,"fork":false,"pushed_at":"2025-02-14T12:24:58.000Z","size":18,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-06-05T11:45:45.244Z","etag":null,"topics":["best-practice","best-practices","document-filing","document-management","document-storage","filing","naming","naming-convention","naming-conventions","naming-pattern"],"latest_commit_sha":null,"homepage":"https://www.ditig.com/document-filing-naming-convention","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ditig-com.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-06T14:18:49.000Z","updated_at":"2025-02-14T12:25:02.000Z","dependencies_parsed_at":"2024-11-20T16:18:37.260Z","dependency_job_id":"43c486c1-fd03-4d59-a382-6c95e0c794fc","html_url":"https://github.com/ditig-com/naming-convention","commit_stats":null,"previous_names":["uhk-ditig/naming-convention","ditig-com/naming-convention"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ditig-com/naming-convention","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ditig-com%2Fnaming-convention","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ditig-com%2Fnaming-convention/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ditig-com%2Fnaming-convention/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ditig-com%2Fnaming-convention/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ditig-com","download_url":"https://codeload.github.com/ditig-com/naming-convention/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ditig-com%2Fnaming-convention/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28890334,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-29T21:06:44.224Z","status":"ssl_error","status_checked_at":"2026-01-29T21:06:42.160Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["best-practice","best-practices","document-filing","document-management","document-storage","filing","naming","naming-convention","naming-conventions","naming-pattern"],"created_at":"2025-03-28T01:53:10.981Z","updated_at":"2026-01-29T23:31:29.911Z","avatar_url":"https://github.com/ditig-com.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Naming Convention for Document Filing\n\nThis repository contains files and instructions to complement the [file naming convention for document filing](https://www.ditig.com/document-filing-naming-convention) article on the [ditig.com](https://www.ditig.com/) website.\n\n\n## SYNOPSIS\n\n`DATE`\\_`TYPE`\\_`CREATOR`\\_`RECIPIENT`\\_`DESCRIPTION`.`FILE-EXTENSION`\n\n\n* **DATE**  \n  Document creation date `YYYY-MM-DD`.\n* **TYPE**  \n  [Predefined](#types-and-examples)\n* **CREATOR**  \n  Creator/issuer/sender of the document\n* **RECIPIENT**  \n  Recipient of the document (optional)\n* **DESCRIPTION**  \n  May include subject, invoice numbers, order numbers, customer numbers, etc.\n* **FILE EXTENSION**  \n  File type extension, e.g. `.pdf`, `.txt`, etc.\n\nAll parts of a file name are ...\n\n* chained together using underscores\n* written so that spaces are replaced by dashes (`-`)\n* written in **all lowercase** UTF-8 character set\n\n\n## TYPES and Examples\n\n### `invoice`\n\nFor all invoice documents.\n\n`yyyy-mm-dd_invoice_creator_recipient_description-invoice-number.pdf`\n\n**Example:**\n\n`2024-10-21_invoice_sofa-king-inc_john-doe_cushy-king-couch-8979803411.pdf`\n\n\n---\n\n\n### `receipt`\n\nFor all receipt documents, e.g. cash receipts.\n\n`yyyy-mm-dd_receipt_creator_recipient_description-receipt-id.pdf`\n\n**Example:**\n\n`2024-10-12_receipt_thai-tanic_john-doe_dinner-with-acme-inc-89720984.pdf`\n\n\n---\n\n\n### `certificate`\n\nFor, e.g. Birth certificate, school certificates, etc.\n\n`yyyy-mm-dd_certificate_creator_recipient_description.pdf`\n\n**Example:**\n\n`yyyy-mm-dd_certificate_mirthful-maternity-clinic_recipient_birth-certificate.pdf`\n\n\n---\n\n\n### `letter`\n\nFor all general communication documents.\n\n`yyyy-mm-dd_letter_creator_recipient_description(-identifier).pdf`\n\n**Example:**\n\n`2024-03-31_letter_penurious-bank-inc_john-doe_bank-account-statement-2024-03-xx75512108001245126199.pdf`\n\n\n---\n\n\n### `contract`\n\nFor, e.g. rental agreements, employment contracts, mandates, etc.\n\n`yyyy-mm-dd_contract_creator_recipient_description.pdf`\n\n**Example:**\n\n`2020-02-02_contract_gongshow-inc_john-doe_employment-contract.pdf`\n\n\n---\n\n\n### `article`\n\nNewspaper articles, blog articles, publications, etc.\n\n`yyyy-mm-dd_article_creator_description.pdf`\n\n**Example:**\n\n`2024-11-06_article_absurdistan-times.com_us-election-results-2024.pdf`\n\n\n---\n\n\n### `clippings`\n\nClippings documents created from, e.g. ebooks, articles, etc.\n\n`yyyy-mm-dd_clippings_description.txt`\n\n**Example:**\n\n`2024-06-27_clippings_barry-schwartz-the-paradox-of-choice-2005.txt`\n\n\n---\n\n\n### `diary`\n\nDaily notes, diary documents.\n\n`yyyy-mm-dd_creator_diary.txt`\n\n**Example:**\n\n`2024-04-02_john-doe_diary.txt`\n\n\n---\n\n\n### `document`\n\nFor documents that do not match any other specific TYPE.\n\n`yyyy-mm-dd_document_creator_recipient_description(-identifier).pdf`\n\n**Example:**\n\n`2024-05-16_document_event-inc_john-doe_midwest-princess-pageant-ticket-1995390976.pdf`\n\n\n---\n\n\n### `offer`\n\nFor written offers received and made.\n\n`yyyy-mm-dd_offer_creator_recipient_description(-offer-identifier).pdf`\n\n**Example:**\n\n`2023-09-01_offer_john-doe_vibetide-inc_website-redesign-1290.pdf`\n\n\n---\n\n\n### `coo`\n\nFor order confirmations.\n\n`yyyy-mm-dd_coo_creator_recipient_(description)(-order-identifier).pdf`\n\n**Example:**\n\n`2023-12-27_coo_shiver-daddy-inc_john-doe_refrigerator-coolio-1-53228398.pdf`\n\n\n---\n\n\n### `manual` \n\nInstruction manuals, assembly instructions, etc.\n\n`yyyy-mm-dd_manual_creator_product-name.pdf`\n\n**Example:**\n\n`2024-01-14_manual_shiver-daddy-inc_refrigerator-coolio-1.pdf`\n\n\n## Character conversion\n\n| Char | Conversion |\n| ---  | --- |\n| ä | ae |\n| ö | oe |\n| ü | ue |\n| ß | ss |\n| ä | ae |\n| æ | ae |\n| œ | oe |\n| ø | oe |\n| å | aa |\n| ð | eth |\n| š | s |\n| ž | z |\n| õ | oe |\n| ë | e |\n| α | alpha |\n| $ | dollar |\n| € | euro |\n\n\n## Illegal characters\n\n* `.` perdiod (only use to separate file name and extension)\n* `,` comma\n* `#` pound\n* `%` percent\n* `{` left curly bracket\n* `}` right curly bracket\n* `\\` back slash\n* `\u003c` left angle bracket\n* `\u003e` right angle bracket\n* `*` asterisk\n* `?` question mark\n* `/` forward slash\n* ` ` blank spaces\n* `$` dollar sign\n* `€` euro sign\n* `!` exclamation point\n* `\"` double quotes\n* `“` double quotes\n* `„` double quotes\n* `:` colon\n* `@` at sign\n* `+` plus sign\n* `` ` `` backtick\n* `|` pipe\n* `=` equal sign\n* emojis\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fditig-com%2Fnaming-convention","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fditig-com%2Fnaming-convention","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fditig-com%2Fnaming-convention/lists"}