I would be honored if you could read this article. Lifelong learning together, born to the sun.

How to become a professional writer? Solve three cores.

  1. Play CARDS
  2. List of steps
  3. Give a demonstration

In this Internet age. To be a popular professional, writing is an essential skill, especially for the workplace. Ability to work, leadership, evidence. What is evidence? Your writing ability is your strongest evidence.

Writing for work, are you polite? Playing cards is the best respect for each other. Playing cards is the entrance, step is the core, to demonstrate is the soul. Read on for a step-by-step guide to writing effectively for the workplace.

BEGIN career Writing

Why study Workplace Writing?

What are the advantages of writing for work?

Still change for subordinate change, want to let the leader change the document that you send less? Once upon a time, is there such a resonance. The resulting document often needs to go back and forth several editions, simply adding V1.0.1 to the title each time.

The following was heard in one of the auditions:

Your writing has the basis of change, this person’s writing is clean.

Sounds like you’re feeling a little sick. So how can you write effectively for the workplace?

Next comes the hardcore, which brings us to the three cores of writing for the workplace.

Three core

One, play cards

Are you polite?

Once upon a time, have you received such a wechat chat: in? In? Do you have a minute? See such wechat message, do not know what the other side is going to do, a face mengbi. This kind of news is not only encountered in the workplace, but also in reality.

The more embarrassed you are, the less the other person will be able to figure out what you’re trying to say. On both sides, it’s a waste of each other’s time.

The other person may want to get straight to the point. Coy? Like what? Does that make sense?

In business writing, playing your cards close to your mouth is the best form of politeness.

  1. To write a staple log, write a clear list of the day’s core tasks in a concise heading.
  2. Write work wechat, playing cards is directly to write out the appeal.
  3. To write a notice is to write who and what to do at the beginning.
  4. By sending an email, you put your concerns directly in the subject line of the email.

This is a very important part of playing cards. Get right to the point and ask for your needs or questions. Don’t be shy, it’s only when you bring it up that you show them the greatest respect. In this age of connected information, no one wants to waste precious time on irrelevant information.

If the entrance to career writing is playing cards, then the steps are the core.

2. List steps

Core: guide the other party to action, to ensure that the process of action is not deformed.

To borrow a famous quote from Zeng Guofan of the late Qing Dynasty:

I keep a kind of quiet in my heart

Meditate, thinking more clearly.

No document starts out as catchy and logical. Basically read it through a few times and then refine it bit by bit.

If you’re listing steps and you don’t have a clue. Don’t think about the logical steps, just draw the general outline, come up with a point and write it down in a notebook. Wrote a lot of intermittent content, read through several times, stand in the perspective of the reader to think, see if it is logical. And then smooth it out.

List the steps, and I’m going to go in these three directions. One is to write project documentation, the other is workplace user training, and the third is the product operation manual.

01 Project Deployment Documents

Logical, step by step. Put yourself in the other person’s shoes and list the steps clearly.

List your own work experience:

  1. Train colleagues on how to deploy tests for corporate Web applications.
  2. Deploy the open source blog and use the documentation on the official website.

1. Train colleagues on how to deploy and test your company’s Web applications

Domestic visual client application software adapted to Linux operating system deployment

  1. Describes the operating system as a whole.
  2. This section describes software installation: Add an installation package using a fixed visual client in offline mode.
  3. Required software packages: Main software package and third-party SDKS.
  4. Setting software startup: Set software startup and restart the operating system.
  5. Log in to the operating system: Log in to the operating system as a common user.
  6. Open the client: Log in to the client software.
  7. Demonstration: demonstrate a series of operations on the client software.
  8. Precautions.

Domestic web application software adapted to Linux operating system deployment

  1. This section describes the operating system.
  2. This section describes software installation: Add an installation package using a fixed visual client in offline mode.
  3. The required software packages include JDK8, DM8 database, and Zhongchuang middleware.
  4. Deploying Web software: Describes how to deploy it.
  5. Test access: Access the Web software in a browser.
  6. Demo: Demonstrate a series of operations on the Web application.
  7. Precautions.

For notes in the project documentation, it is recommended to put them first. I’ve written a lot of documentation, step-by-step lists and screenshots with text captions. Personally test and verify before sending to the other party, but the other party estimates that it does not take seriously, really need when, often directly call to help. Later, I simply wrote notes in the front, and then listed step by step, to prevent the other side of the operation deformation.

The steps I described in the article are very simple. In real documents, each step needs to be enumerated in detail, including precautions. When writing the project document, I reflected on how to make the readers follow my instructions to achieve the ultimate goal if I was a person who had no contact with the IT software industry.

Readers can give you certain suggestions, but only with external pressure to improve yourself.

There is a famous saying in the Analects of Confucius, which is worth our lifelong learning:

Zeng Zi said, “I have examined myself three times a day: have I been disloyal to others? Make friends and not believe? Is it not a habit?” .

The most effective way to reflect on the conclusion is not to ask others to correct, but to reflect on yourself. Read through the document, preferably silently. At least let the logic of a closed loop, the final step to adjust the modification. Be concise and write less wordy sentences to avoid interference.

2. Deploy the open source blogging platform, using the documentation on the official website

Recently I came into contact with an open source blogging system, Halo, which has a beautiful interface and is not very difficult to get started.

  1. Select the deployment platform: Windows
  2. Mandatory deployment environment: JDK11
  3. To start the service, run the following command on Windows:Java jar halo - 1.4.17. Jar
  4. Browser: http://localhost:8090

Introduce an open source software to use, take steps, guide users to use, in an efficient way to see the effect.

User training in the workplace, to achieve simple, orderly, logical clear, whether from vertical or horizontal, and finally form a logical closed loop.

Users don’t care what technology is used in your software, they really care how quickly it can be used to meet the needs of the job. Of course, a presentation needs to be timed, and the opening line can be a bit more sophisticated and mysterious with a bit of development technology. For user training, consider time surplus and put considerations into the closing phase.

02 Workplace user training

Train users on how to use your company’s Web applications

  1. Prologue: very important, quickly bring the training users into the state.
  2. Open the browser: guide where to open the browser, at least one way.
  3. Accessing the Web software: Enter the access address in the address bar of the browser.
  4. Favorites: allows users to collect common software addresses for easy access.
  5. Login page: Describes the login page of the Web software.
  6. Demonstrate the basic functionality of Web software: horizontal or vertical, overall grasp of the logical order.
  7. Precautions: Precautions for using the browser.

Simple, complex matters simple, structured, so that users know the first impression of the operation is very simple, with users quickly into the state. Order, the column steps of the second major step, read sequentially. Logic is clear, within the scope of this logic, to form a logical closed loop.

In life, we always encounter some products, how to quickly interact with a new product, product instruction is the best teacher.

03 Product Operation Manual

Give a few examples from your personal and professional life.

What are the most familiar examples from your life? Of course, every time I buy a product, I will read the manual, experience the product and verify whether it is in good condition.

1. Product specifications

I recently bought a wireless mouse. Here’s how it works. The instructions are concise and designed to teach you how to use them quickly. In fact, there are picture examples for each step, which I have deliberately left out to separate the column steps from the demonstration. Often a list of steps is closely linked to a demonstration.

  1. Slide back to remove the battery cover.
  2. Remove the wireless receiver and plug it into the USB port of your computer.
  3. Install the battery into the battery compartment (pay attention to the positive and negative terminals) and close the battery cover.
  4. Flip the bottom black button up.
  5. The product is installed successfully.

From this, you can see that the product description teaches us how to use the product quickly in a clear step-by-step manner. Users do not care about the structure of the product, so the product specification is a piece of paper.

I didn’t go home for the Spring Festival this year. On New Year’s Eve, my parents turned on the TV at home and called me to say that the TV at home was broken. Under my remote guidance, there was no interactive screen on the description screen, indicating that the network could not be connected. I have a feeling after the remote guidance, applied to the article.

2. The TV can’t play the content

The second example is from my real life experience. Big New Year, can’t watch the Spring Festival gala at home, pretty depressed.

Here are the steps I took to remotely teach my father how to do the screening:

  1. Check that the light cat is working properly and reboot to see what happens.
  2. Check whether the connector of the network cable (crystal connector) connecting the optical cat is loose.
  3. Check whether the network cable connector (crystal connector) of the router is loose.
  4. Check whether the cable connector (crystal connector) between the TV set-top box and the router is loose.
  5. Restart the TV set-top box with a black button that clearly describes where to operate.
  6. Finally, the TV signal source to HDMI, successfully solve the problem.

In the case of remote instruction, each step is described in detail.

There are many examples in the workplace, when we are introduced to a new product, development language or technology, or application software. In the Internet industry, the program ape, we estimate that the ears have heard the cocoon of it. The much-loved Github website lists how to use the product as well.

3, Github repository instructions

In fact, most of the time, most people know the difference between an unordered list and an ordered list. But often in use, and did not deliberately distinguish the difference between the two. For example, WHEN I used to itemize multiple items, I only used an unordered list, which made me look comfortable. When the reader looks at it, it’s an unordered list, so does it matter if I start with any of them? If ordered and unordered lists are used indiscriminately, the reading experience will be affected.

The introduction of the original github newly built warehouse is as follows. The Chinese on the picture is added by me:

Next I’ll go through a list of steps to revamp the official instructions.

Here is a programming example, creating a new warehouse demo to operate in three steps:

  1. Initialize a repository with a command.
  2. Connect the remote warehouse.
  3. Import code from other remote repositories.

There are 7 steps to initialize a warehouse demo:

  1. Add a readme. md file: echo “this is demo” >> readme.md
  2. Initialize the repository: git init.
  3. Git add readme.md
  4. Git commit -m “First commit”
  5. Switch to master: git branch -m master
  6. To connect to a remote warehouse demo: git remote add origin [email protected]: cnwangk/demo. Git.
  7. Git push -u origin master

Official example: Initialize a new Github repository demo

In listing the steps, I’ve listed no fewer than six examples, from real experience in the workplace, from real life, and from github, an open source community familiar to programmers. Listing so many examples, I want you to understand the importance of steps, the core of workplace writing.

If the core of writing for the workplace is to lay out the steps, then demonstrating them is the soul.

Three, give a demonstration

At first, I wanted to find a few sample images to illustrate. On reflection, I found that was irresponsible. In the end, I decided to draw my own examples from my actual work, and then illustrate them with written instructions. Closer to real life.

To demonstrate, is to give each other a sample template, better guide each other to action. Reduce the difficulty of the operation, in one step.

It doesn’t have to be a video, a POWERPOINT presentation, it can be a written description. It can also be a Word document record, preferably screenshots with text description.

To name a few familiar examples, employment contract entry date, travel expenses incurred.

01 Entry date

Enter the date in the same format. Instead of adding 0 before the day and month, refer to the date format on your ID card.

For example, enter the date in the format of February 9, 2022.

The cover of the labor contract, the end page of the labor contract and the cover of the confidentiality contract are shown below. This is just a reference sample to give you a little bit of perspective.

Example: labor contract cover sample, formal should be white, here changed to eye color, look more comfortable.

Example: End page of labor contract

Example: Cover of employee confidentiality Agreement

02 Expense Account

Fill in the expense accounts, accountants can also give colleagues a template sample, both worry and trouble.

For example, the details of an expense bill:

  1. On the left is filling in the reimbursement details;
  2. On the right is the amount of reimbursement in Arabic;
  3. Fill in the bottom of the reimbursement amount in capital Chinese characters, reimbursement date and the name of the applicant.
  4. You may need to paste your own ticket.

We are all familiar with labor contracts, confidentiality agreements and expense accounts. Seeing an example like this might give you a second thought. When explaining to others, whether can also provide a template for explanation, for the other party a reference. As convenient for yourself, so convenient for others.

03 Website Visit

Give an example of how to use the template and let the user follow suit.

1. Demonstrate the operation of accessing a Web application software

Open Internet Explorer on Windows and enter the access address in the address bar to log in, as shown in the following figure.

Demo Internet Explorer to display favorites in the status bar, right click at the top of the browser, as shown below:

This section describes how to set the Internet Explorer Compatibility view

  1. Click the white gear icon in the top right corner of your browser
  2. Then click compatibility View Settings, as shown below:

When I travel, I often think about how to make it as clear as possible to my users and bring a little humor to it. The lecture was so boring and long that no one was interested in listening to it. The best way to do this is to interact with the audience and get them interested. Once in a while to underline the point, once you hear the point, more or less attention will focus a little.

Next, demonstrate the startup of a software service.

2. Demonstrate starting a software service

In fact, the detailed steps should be like this:

  1. Download the Web software Halo and confirm the corresponding operating platform.
  2. Prerequisites Installation environment: JDK11.
  3. View the installed JDK version.
  4. Open a CMD command window to start the Halo service.
  5. Access Halo in the browser address bar.

In order to demonstrate the demonstration template, the following introduction is simplified in several steps.

Here we borrow the Halo blog I introduced in the column steps and start the Halo service as shown below:

Start the service

Java jar halo - 1.4.17. JarCopy the code

Browser access to Halo service address: Native tests are accessed using localhost or 127.0.0.1 plus port 8090.

http://127.0.0.1:8090/admin

Login to Halo: Enter your user name and password and click Login to enter the background administration screen.

In the process of giving a demonstration, there are many pictures and illustrations supported by text. Pictures also have standards, picture size should not be too large, it is best to unify the size, give a person a kind of overall aesthetic feeling. If the image is used properly, it is definitely the soul.

Let’s say you’ve mastered the three core elements of professional writing: lay out the cards, lay out the steps, and demonstrate.

Then the groundwork is laid, and the icing on the cake is on the cake. Polish your document, or layout, to make it more comfortable to look at.

Icing on the cake, design and layout

At work, if you were presented with a document without any typography or a document with typography, clarity, and focus, which one would you prefer to read? The answer is obvious: simple aesthetics, clear structure and focus.

A well-written article, poorly formatted, you will lose the desire to read it.

Here are three principles and seven tips for typography.

01 Three principles of layout design

  1. Simple and beautiful
  2. The structure is clear
  3. An emphasis on

Simple and beautiful: with personal aesthetic hooks. Generally speaking, the first thing you see is simple and elegant, with no fancy special effects. Simple, let people see the resources they want at the first time, get the reading experience, too fancy will reduce the reading experience.

Clear structure: If your document is only a few sentences long, there is no need to overformat it. Words are a lot of words, can be simplified, modular, structured, people feel logical, very clear, easy to read, high acceptance rate of readers.

Focus prominent: control the focus, priority principle. Generally, the conclusion is put at the beginning, so that the reader can get the key point at a glance. The beginning, the end, the title, the subtitle, the key sentence to strengthen, that is, bolder font, adjust the size. Highlighting sentences in red is also a good way to highlight them.

02 Seven skills of typesetting

1. Font and size specification

Individuals generally follow a set of rules when writing project documentation. This established rule, if the previous standards, to follow the previous standards is done. For example: at the beginning of the big title with Song Typeface (title) bold display, one, two, three size distinction, text font size generally use song typeface small four or five (text). There are also special cases, will use a variety of fonts to foil, such as the design of the cover will be several subtitles, the use of boldface, song Style, founder yao. Avoid font style is not excessive, avoid mixed.

The example given above has established rules, and the other case has no established rules. Create your own set of rules and let others follow your rules. Title design, can use boldface, pay attention to uniform heading font. Text font design, choose the general public is easy to accept the song typeface, generally use Office or WPS default text is song typeface, so there is no mistake. The font size can follow the size given in the title of the office software, and the body size is usually set to minor 4 or 5.

2, the article color specification

Article color scheme should not exceed 3, too many colors, appear very chaotic.

3. Modularization of content

For example, the bus, subway, start will remind the name of the next station, each to the next station before, will prompt xx station is coming. For example, the train, have taken harmony or Fuxing more or less impression, every stop, will be ahead of the voice announcement, XX station is coming, please passengers friends ready to get off in advance.

I think modularity is the best way to condense subheadings.

4. Standardize paragraphs

Keep paragraphs to four or five lines for a comfortable reading experience.

Using transitional sentences is a classic technique in the college entrance examination. This paragraph, in one sentence, serves as a link between the past and the future.

5. Focus

Use leads properly to inform the reader that the key point is coming. In general, when you see highlights, your attention will more or less linger.

Key statement, color the font, bold, highlight the key content.

6, appropriate illustrations

Once upon a time, is not heard: no picture said what? Rough reason is not rough, there is a persuasive figure better.

Appropriate pictures are the soul of professional writing, and pictures are best accompanied by text.

One of the great benefits of accompanying images is that they buffer the reader from the fatigue of reading your long text. When you see the picture, your attention will stay on the current picture for a while and get a proper rest.

7. White space art

Left blank in the case of considering wholeness.

Space between lines, space between paragraphs, space between subheadings, space between text and images.

The final design and layout was just icing on the cake.

This is the end of this article. To recite, there are three core elements to writing for work: if the entry point to writing for work is to lay out the cards, then the steps are the core. If the core of writing for the workplace is to lay out the steps, then demonstrating them is the soul.

I am honored if you can read this article. Hope to be helpful to your career, born to the sun.

END is born to the sun

Born to the sun, born to the sun.

I have read and listened to this book every year since I came into contact with it five years ago. Recently, I read the letter to Zeng Guofan’s family again and felt deeply.

Quoting the late Qing Dynasty zhongxing first minister, a generation of great Confucian Zeng Guofan a few famous quotes, quite useful.

I keep a kind of quiet in my heart.

Calm down and think clearly. It’s the same with reading. It’s immersion. It’s total immersion.

The following sentence is more reasonable to say that the couplet. Don’t ask the harvest, but ask the hard work.

First allied: not for the sage, then for the beast.

Don’t ask for the harvest, but ask for the hard work.

When counting your gains, ask yourself how much you’ve given.