Atlas - TRX-26-0001.txt
Home / doc / TRX Lines: 1 | Size: 7870 bytes [Download] [Show on GitHub] [Search similar files] [Raw] [Raw (proxy)][FILE BEGIN]1 TECHNICAL RECORD EXCHANGE INTRODUCTION 2 TRX-26-0001 3 04/03/2026 4--------------------------------------------------------------------------- 5TITLE: TECHNICAL RECORD EXCHANGE INTRODUCTION 6DOCUMENT ID: TRX-26-0001-A1 7REVISION: A1 8CATEGORY: DESIGN AND PROTOCOL 9COPYRIGHTS: (C) 2026 0x4248. CC BY-SA 4.0. 10USAGE RIGHTS: All rights given under CC BY-SA 4.0 11LICENSE: CC BY-SA 4.0 12 13DATE CREATED: 4 March 2026 14DATE REVISED: 4 March 2026 15 16--------------------------------------------------------------------------- 17REVISION HISTORY 18--------------------------------------------------------------------------- 19REVISION DATE NOTES 20A1 4 March 2026 Initial creation of record. 21 22--------------------------------------------------------------------------- 23CONTENTS 24--------------------------------------------------------------------------- 25 261.0 SCOPE 272.0 TRX NUMBERING SYSTEM 283.0 DOCUMENT FORMAT REQUIREMENTS 294.0 SIGNATURES 30 31--------------------------------------------------------------------------- 32ABSTRACT 33--------------------------------------------------------------------------- 34 35Introducing the new 4248 Systems Technical Record Exchange (TRX) format. A 36standardized format for sharing and archiving technical records such as design 37proposals, technical documentation, and project reports and other technical 38documents. TRX is designed to be simple to track, write, read and share. With 39each record being assigned a unique identifier and revision code. 40 41This makes TRX ideal for long term archiving and sharing over the old DPX 42letter like format. 43 44--------------------------------------------------------------------------- 451.0 SCOPE 46--------------------------------------------------------------------------- 47 481.1 This standard applies to all technical memoranda, engineering notes, 49 research reports, data compilations, and internal communications 50 formally issued under the TRX designation. 51 521.2 The TRX numbering system shall be applied to all controlled 53 technical documents intended for archival retention. 54 55---------------------------------------------------------------------------- 562.0 TRX NUMBERING SYSTEM 57--------------------------------------------------------------------------- 58 59TRX uses a structured numbering system to uniquely identify each record. 60The format is as follows: 61TRX-YY-NNNN-R 62 63Where: 64- TRX: The prefix indicating the document is part of the Technical 65 Record Exchange. 66- YY: The last two digits of the year the record was 67 created (e.g.. 26 for 2026). 68- NNNN: A sequential four-digit number assigned to each record. 69- R: A revision code (e.g.. A, B, C, etc.) indicating the version of the 70 document. It can also be a letter followed by a number for minor 71 revisions (e.g.. A1, A2, etc.). 72 73This allows for a simple way to track and reference documents, with the year 74providing context for when the record was created. If the record count ends 75close to 9999 in a year, the sequential number can reset on new years day. 76 77This is unlikely since I don't expect to write 10k documents. 78 79--------------------------------------------------------------------------- 803.0 DOCUMENT FORMAT REQUIREMENTS 81--------------------------------------------------------------------------- 82 833.1 BASIC GUIDELINES 84 85Documents following the TRX format should adhere to the following guidelines: 86- Use a clear and concise title that reflects the content of the document. 87- Include a unique TRX identifier and revision code on the cover page. 88- Provide an abstract summarizing the key points of the document. 89- Use a consistent structure with sections and subsections as needed. 90- Include a revision history table to track changes over time. 91- Use clear and professional language, avoiding jargon where possible. 92- Include references to any sources or related documents. 93- Ensure that all figures, tables, and data are properly labeled and referenced 94 in the text. 95 963.2 FILE FORMAT 97 98The document should begin with a easy to read header, no nonsense formatting. 99Just use the tab key, works in almost every typewriter and IBM Compatible 100computer. The document should be saved in a widely compatible format such as 101plain text (.txt). Non editable formats can be used but only for sharing and not 102for the official copy. Post script should be used for printing to keep the 103font and formatting consistent across different printers. 104 105Any 80 col dot matrix printer can print the document without any formatting 106this is because of how well the format is designed to be compatible with old and 107new technology. 108 1093.3 HEADERS 110 111A brilliant example is already in this document, go to page 1. Here is a list of 112the fields you can use: 113- TITLE: The title of the document. 114- DOCUMENT ID: The unique identifier for the document following the TRX numbering 115 system. 116- REVISION: The revision code for the document. 117- CATEGORY: The category or type of document (e.g.. Design and Protocol, Report 118 Experimental Results, you name it!). 119- COPYRIGHTS: The copyright information for the document, including the year and 120 the author or organization. 121- USAGE RIGHTS: A brief statement of the usage rights for the document, such as 122 "All rights given under CC BY-SA 4.0". 123- LICENSE: The specific license under which the document is released (e.g.. CC 124 BY-SA 4.0). 125- DATE CREATED: The date the document was originally created. 126- DATE REVISED: The date of the most recent revision to the document. 127 128Optional fields include: 129- AUTHORS: A list of the authors who contributed to the document. 130- AFFILIATIONS: The affiliations of the authors (e.g.. 4248 Systems, 131 University of Somewhere, etc.). 132- KEYWORDS: A list of keywords relevant to the content of the document for 133 indexing and search purposes. 134- SUMMARY: A brief summary of the document's content, similar to the abstract 135 but can be more detailed and include specific findings or conclusions. 136- RELATED RECORDS: A list of related TRX records that are relevant to the 137 content of the document, including their TRX identifiers 138 for easy reference. 139- PRECEDES: A list of TRX records that this design improves upon or is based on, 140 including their TRX identifiers for easy reference. 141 142These should be put into a heading like format: 143- ABSTRACT: A brief summary of the document's content and purpose. 144- CONTENTS: A list of the main sections and subsections of the document. 145 1463.4 REVISION HISTORY 147 148A revision history table should be included to track changes to the document 149over time. The table should include the following columns: 150- REVISION: The revision code (e.g.. A, B, C, etc.) 151- DATE: The date of the revision. 152- NOTES: A brief description of the changes made in the revision. 153 154 1553.5 FIGURES AND DATA 156 157Since its not the best idea to put images in text files, you should save any 158relating files in the same folder as the document and reference them in the 159text. 160 161For example: 162"For a visual representation of the sine wave, see [SIN_WAVE_GRAPH.PNG]" 163 164Files are linked as [FILENAME.EXTENSION]. 165 1663.6 REFERENCING RECORDS 167 168When referencing other TRX records, use the full TRX identifier for clarity. 169For example: 170"As discussed in TRX-25-234545-A1, the design proposal for..." 171 172--------------------------------------------------------------------------- 1734.0 SIGNATURES 174--------------------------------------------------------------------------- 175 176Written By: _________________________ Date: __________ 177 178 Signature: _________________________ 179 180 181Reviewed By: _________________________ Date: __________ 182 183 Signature: _________________________ 184[FILE END](C) 2025 0x4248 (C) 2025 4248 Media and 4248 Systems, All part of 0x4248 See LICENCE files for more information. Not all files are by 0x4248 always check Licencing.