From 0870dddf7266e168391d546b80ab434d4b64cadd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?benjamin=20melan=C3=A7on?= Date: Mon, 1 Apr 2024 23:01:29 -0400 Subject: [PATCH] Add a client communication section with document versioning as first part --- .../document-versioning-filenames.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 client-communication/document-versioning-filenames.md diff --git a/client-communication/document-versioning-filenames.md b/client-communication/document-versioning-filenames.md new file mode 100644 index 0000000..967fbf0 --- /dev/null +++ b/client-communication/document-versioning-filenames.md @@ -0,0 +1,19 @@ +## Document versioning and filenames + +Please use the following file naming convention for all client-facing filenames: + +``` +agaric-[client-name]-[purpose]-[yyyy-mm-dd].ext +``` + +For example: + +``` +agaric-acme-jetpacks-proposal-2024-05-23.pdf +``` + +Always use dates, do not use revision numbers, and never use 'final' in a file name. A final-final-FINAL doc is only funny a couple times. + +This applies to the final sent versions of files, typically PDFs. The word processing document (.odt, .doc) or Markdown (.md) working versions should follow the same format for their file names, for convenience, but leave off the date. + +For more on document naming reasoning see http://alistapart.com/article/looking-for-trouble#section1