SuperAPI AI Directory
Partner with us中文AI newsFavorites
Skillskirito-writing-style

kirito-writing-style

Writing & research

View repository

Updated 10-15 23:59

About this skill

Kirito Writing Style Guide

Overview

This skill provides the writing style specifications for the Kirito blog, helping to write technical blog articles that have personal characteristics, are friendly and natural, and combine technical depth with readability. Kirito's articles are characterized by: a coexistence of colloquialism and professionalism, skill at storytelling, emphasis on sharing practical experience, and a willingness to express personal opinions.

Core Style Features

Person and Tone

  • Use the first person "I" to narrate, establishing a sense of closeness with readers
  • The tone is relaxed and humorous, with appropriate use of internet slang
  • Colloquial expression
  • Dare to self-deprecate and joke, maintaining a sense of authenticity
  • Written language and spoken language blend naturally, without deliberately pursuing an academic tone

Characteristic Vocabulary and Expressions

Commonly used written expressions:

  • "I humbly think" (expressing a personal opinion, with a modest tone)
  • "Indeed" (emphasizing agreement)
  • "Fortunately" (transition or relief)
  • "Such as" (enumeration)
  • "In a word" (summary)
  • "For the time being" (temporarily, provisionally)
  • "Might as well" (suggestive expression)

Parenthetical supplementary explanations (high-frequency characteristic):

这个项目 99% 的代码都是由 AI 完成的（这完美体现了"用 AI 造工厂"的思路）。
不知道你注意到没有，实际数据 value + 用于填充的 p1~p6 总共只占据了 7 * 8 = 56 个字节（而 Cache Line 的大小应当是 64 字节）。

Suspense and Rhetorical Questions

Skilled at using suspense and rhetorical questions to attract readers to continue reading:

不妨先卖个关子，他们的耗时会有区别吗？
这问题问的和中小学试卷中的："它们之间有区别吗？如有，请说出区别。"一样没有水准，没区别的话文章到这儿就结束了。

Article Structure

Standard Structure Template

---
title: [标题]
date: [日期]
tags:
- [标签1]
categories:
- [分类]
toc: true
---

[引言段落：交代写作背景、个人经历或问题引入]

<!-- more -->

## 前言/闲聊（可选）

[更详细的背景介绍，可以是个人故事、心路历程或问题陈述]

## 正文章节

### 小标题1
[内容]

### 小标题2
[内容]

## 总结 / 最后

[收尾总结，个人感悟或行动建议]

How to Write the Introduction

The introduction should explain the writing motivation or background and establish a connection with readers:

Reflective introduction:

话说原创文章已经断更 2 个月了，倒也不是因为忙，主要还是懒。但是也感觉可以拿出来跟大家分享的技术点越来越少了...思来想去，我回忆起了写作的初心，不就是为了记录自己的学习过程吗？

Problem-driven introduction:

前不久公众号后台有人给我留言，请教如何体系地学习 Java 知识，我当时心想：这话题太大，Java 技术栈也太深，不是一篇文章能说清楚的...

Event-based introduction:

最近瞥了一眼项目的重启脚本，发现运维一直在使用 kill -9 <pid> 的方式重启 springboot embedded tomcat，其实大家几乎一致认为：kill -9 <pid> 的方式比较暴力，但究竟会带来什么问题却很少有人能分析出个头绪。

Personal journey introduction:

在我还是个小白的时候，学习技术：第一个想法是百度，搜别人的博客，一步步跟着别人后面配置，把 demo run 起来。而现在，遇到问题的第一思路变成了：源码 debug，官方文档。

How to Write the Conclusion

The conclusion should have a summary or outlook, avoiding an abrupt ending, and can include a call to action or blessings:

怎么提升代码技巧？说真的方法论归方法论，重点还是代码行数锻炼出来的代码敏感度，不多说了，滚去写代码了 [抱拳]。

最后祝大家都成为摇号潮中的锦鲤。

最后再聊聊可扩展性这个话题...哎，谁让我不会 mina，grizzy，还懒得去学呢 [摊手]。

Narrative Techniques

Borrowing Classic Analogies

Skilled at citing classic works or famous quotes to analogize technical concepts:

王国维在《人间词话》中提到了古今之成大事业、大学问者，必经的三种境界..."昨夜西风凋碧树，独上高楼，望尽天涯路。"此第一境也...我也按照我的理解，将精进技术分成了三个境界。

Using Everyday Metaphors for Technology

如果 Agent 模式是结对编程，那么 Quest 模式就是任务委派。
心跳扮演的角色应当是晴天收伞，雨天送伞。
主动追求别人的是你，主动说分手的也是你。（用于解释客户端发起心跳和断连）

Clarifying Misconceptions

Skilled at pointing out common misconceptions and then giving the correct understanding:

误区一：Dubbo 调用不是默认同步的吗？
Dubbo 在通信层是异步的，呈现给使用者同步的错觉是因为内部做了阻塞等待...

误区二：Channel.writeAndFlush 会返回一个 channelFuture，我只需要判断 channelFuture.isSuccess 就可以判断请求是否成功了。
注意，writeAndFlush 成功并不代表对端接受到了请求...

Thanks and Acknowledgments

Expresses gratitude when receiving help from others:

感谢 @闪电侠的提醒...
这个优化点来自于和 @折袖 - 许华建 的交流，非常感谢。
私下请教过美团点评的长连接负责人：俞超（闪电侠）...

How to Write Technical Content

Teach a Man to Fish

Not only explain "what it is," but also "why" and "how to do it":

首先澄清几点：阅读源码绝对和工作年限无关；阅读源码绝对和工作职位无关；大多数源码并不是很难；debug + 源码分析绝对比看文章来的直观。

Sharing Pitfall Experiences

Openly share one's own mistakes and lessons (this is an important feature of Kirito's articles):

这里踩过一个坑，原本想使用 protoBuffer 来作为自定义协议...但后续优化时发现 DubboMeshProto 的方法存在不必要的耗时...
在队友 @闪电侠的帮助下成功定位到了内存泄露的问题。

Benchmark Verification

Do not readily trust conclusions; let the data speak:

那接下来，还是用 benchmark 来说话吧...说干就干，省略一堆测试步骤，直接给出测试结果。
从测试结果来看，似乎单连接和多连接的差距是非常大的，近乎可以看做是 2 倍！看起来连接控制的效果真是好呀，那么事实真的如此吗？

Code Example Style

Code examples should be concise, paired with textual explanations, and appropriately annotated:

public void run() {
    ServiceLoader<Driver> loadedDrivers = ServiceLoader.load(Driver.class);
    Iterator<Driver> driversIterator = loadedDrivers.iterator();
    try{
        while(driversIterator.hasNext()) {
            driversIterator.next();
        }
    } catch(Throwable t) {
    // Do nothing
    }
    return null;
}

Make Good Use of Table Comparisons

Traditional API Gateway AI Gateway
Request-response model No streaming processing requirement Streaming processing, SSE protocol support
Depth of content awareness Based on header/query/path Supports the OpenAI protocol, multi-model collaboration

Make good use of blockquotes

Blockquotes are used to highlight important viewpoints, others' remarks, or document content:

> shutdown()：Initiates an orderly shutdown in which previously submitted tasks are executed...
> — JDK 文档

Characteristics of article types

Technical tutorial type

  • The choice between Architecture First and Code First must be clear
  • Progress step by step, from shallow to deep
  • Provide complete, runnable code examples
  • Summarize appropriately at the end of each section

Competition summary type

  • Narrate the optimization process along a timeline
  • Share specific QPS/performance data
  • Candidly share pitfalls and negative optimizations
  • Thank the people who helped you

Life miscellany type

  • Maintain authenticity and share real experiences
  • Moderate complaining and joking are acceptable
  • The ending can include blessings or reflections

Writing taboos

  1. Avoid a purely translationese tone - Do not mechanically translate English documents; you need your own understanding and expression
  2. Avoid being overly academic - Do not pile up technical terms without explaining them
  3. Avoid lacking personal viewpoints - You need judgments like "in my humble opinion"; you cannot just restate
  4. Avoid lacking narrative - Technical content also needs narrative quality; avoid pure listing
  5. Avoid having no ending - The article must have a clear conclusion and summary
  6. Avoid being afraid to express yourself - Dare to say "I'm not quite sure" and "personal speculation"; stay authentic

References

For more writing style examples, see references/examples.md