Skip to content

igor-rosliakov-techwriter/User-Facing-Technical-Writing-Samples

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 

Repository files navigation

User-Facing Technical Writing Samples

This repository contains a curated collection of user-facing technical writing samples, focused on explaining technical concepts and workflows in a clear and accessible way.

The materials are designed for non-expert users, beginners, and product users. The original articles are published in Russian. Each entry includes an English summary to provide context and highlight the scope and intent of the material.

What Is Git and How Version Control Works

This article introduces Git and version control systems from the ground up, explaining why they are used and how they help developers work with code safely and efficiently. It covers core concepts such as repositories, commits, branches, and version history, focusing on the mental model behind Git rather than command memorization. The article is written for beginners who have never worked with version control before. The material can be used for onboarding documentation, learning materials, or user-facing guides explaining basic development tools.

Original article (RU)

How APIs Work: Understanding REST APIs

This article explains what APIs are and how they enable different programs to communicate with each other, using REST APIs as a practical example. It focuses on core concepts such as requests, responses, HTTP methods, and data formats, without requiring backend development experience. Real-world analogies and examples are used to make abstract ideas easier to understand. The material is suitable for product documentation, introductory technical guides, and onboarding content for users interacting with API-based services.

Original article (RU)

How APIs Are Tested: Tools and Workflows

This article explains how developers test APIs to ensure they work correctly, using REST APIs as a practical example. It introduces common testing approaches and tools such as curl, Postman, and Python-based requests, focusing on workflows rather than automation frameworks. The article shows how API responses are inspected, validated, and debugged in practice. The material can be used in onboarding documentation, product support materials, or guides explaining API usage and reliability.

Original article (RU)

How Asynchronous Code Works in Python

This article explains the fundamentals of asynchronous programming in Python, focusing on how async code behaves rather than low-level implementation details. It introduces key concepts such as event loops, coroutines, and async/await syntax, showing how asynchronous execution helps applications handle multiple tasks efficiently. The emphasis is on building a correct mental model of asynchronous workflows. The material is intended for beginners and intermediate learners who want to understand asynchronous behavior before using it in real projects or documenting such systems.

Original article (RU)

Hashing in Python: Concepts and Practical Use

This article provides a clear explanation of hashing in Python, covering both conceptual foundations and practical use cases. It explains how the built-in hash() function works, how cryptographic hashes differ from regular hashes, and when tools like hashlib, HMAC, and password hashing should be used. The article focuses on correct usage and common misconceptions. The material is suitable for educational content, security-related documentation, and user-facing explanations of data integrity and authentication mechanisms.

Original article (RU)

How to Remove a Miner from Windows 10/11

This article is a step-by-step troubleshooting guide explaining how to detect and remove cryptocurrency mining malware from Windows systems. It covers common infection symptoms, monitoring system load, checking startup processes, using antivirus tools, and performing manual cleanup when necessary. The focus is on practical actions and user safety rather than deep security theory. The material is suitable for user-facing support documentation, help center articles, and security awareness content for non-technical users.

[Original article (RU) (https://thecode.media/kak-udalit-mayner-s-kompyutera/)

About

A curated collection of user-facing technical writing samples. The materials focus on explaining technical concepts, tools, and workflows in a clear and accessible way for non-expert users and beginners. Topics include Git, APIs, security basics, troubleshooting, and product onboarding.

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors