agaric/documentation
10
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add a client communication section with document versioning as first part

Browse source
This commit is contained in:
benjamin melançon 2024-04-01 23:01:29 -04:00
parent 9cee628bc8
commit 0870dddf72
1 changed files with 19 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
client-communication/document-versioning-filenames.md Normal file
View file

@ -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