Update GUIDE.md #172
Closed
Update GUIDE.md #172
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Problem Analysis 1. Repetition and Redundancy The Introduction repeats concepts (e.g., what a computer is, what software is, etc.) that are either: Already known to most readers. Re-explained in later sections in more detail. Concepts like binary, source code, QR encoding, UTF-8, and ASCII are explained multiple times across different sections. 2. Overly Broad Audience Assumption The text shifts between assuming the reader is from a highly advanced future society and also possibly having no computer knowledge. This mixed targeting creates tone and focus issues. 3. Overly Verbose and Narrative Tone The tone is often more literary and philosophical than instructional, which can obscure critical technical information. For example, the metaphorical comparison of files to "bags of sand" is engaging, but slows comprehension. 4. Buried Key Information The actual steps for archive extraction (identifying frames, decoding QR, decompressing files, etc.) are hidden deep and not presented in a quick-reference format. Important identifiers like SHA-1, UTF-8, QR structure, archive format (.tar), and compression standards are scattered and informal.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem Analysis
Already known to most readers.
Re-explained in later sections in more detail.
Concepts like binary, source code, QR encoding, UTF-8, and ASCII are explained multiple times across different sections.
Overly Broad Audience Assumption The text shifts between assuming the reader is from a highly advanced future society and also possibly having no computer knowledge. This mixed targeting creates tone and focus issues.
Overly Verbose and Narrative Tone The tone is often more literary and philosophical than instructional, which can obscure critical technical information. For example, the metaphorical comparison of files to "bags of sand" is engaging, but slows comprehension.
Buried Key Information The actual steps for archive extraction (identifying frames, decoding QR, decompressing files, etc.) are hidden deep and not presented in a quick-reference format.
Important identifiers like SHA-1, UTF-8, QR structure, archive format (.tar), and compression standards are scattered and informal.