[If you are enlightened] Step 7: Change your plain text report face

The so-called plain text work report, that is, the work is summarized and reported in plain text. Without the powerful data processing functions of Excel and the brilliant presentation form of PPT, many reports are difficult to understand or even obscure.

This article is based on the original report.7-step method(Personal theory), turning it into an easy-to-understand and qualified report.

Original Report:

I read the demand statement for one hour in the morning, and read the outspec and innerspec. I found a requirement problem, which of the following states can be modified by XXX. After discussing with the team members and leaders, we found that it was a requirement that we could not interpret on our side, and QA had already gone out as a requirement question. Next, according to the SD completed last week, PG started around, and code about 0.2ks was compiled in the morning.

It took an hour in the afternoon to complete the implementation of the entire function A, with a total of 0.43ks code to be reviewed.

When pg of the function is finished, the leader arranged to test function B. The customer said that this function seemed to be faulty. He wanted to know if it was a code problem on our side. He had logged on to redmine and asked us to investigate it, so I tested it and finally found that there was no problem in the simulator, but there was a problem in the real-machine environment. The customer later said it was not the code problem on our side, but the problem of their code merging. After testing the B function, I tested the black box test of the C function. I tested 30 use cases, one bug, and another one was put on hold because the simulator could not be tested, the progress may be delayed.

If you pull an ordinary person, you may feel confused when you read the above report. Unless your boss is too busy for a long time, you may just say "study" this report. In more cases, you should simply lose sight of it. Next, modify our original report.

 

Step 1. Classification

There are many classification methods, and there are two common classification methods: Time class and space class.

■ Time class. That is, the work of each time period is put together by taking the time period as the class.

■ Spatial class. That is to say, the work content with high Coupling Degree is put together.

[Original report] is used for display to the boss. From the boss's perspective, it is concerned about what you have done, rather than what time period you have done. Therefore, according to the spatial classification, the supervisor will be given a glance at the reporter's work. The modified effect is as follows:

Function a coding job

I read the demand statement for one hour in the morning, and read the outspec and innerspec. I found a requirement problem, which of the following states can be modified by XXX. After discussing with the team members and leaders, we found that it was a requirement that we could not interpret on our side, and QA had already gone out as a requirement question. Next, according to the SD completed last week, PG started around, and code about 0.2ks was compiled in the morning.

It took an hour in the afternoon to complete the implementation of the entire function A, with a total of 0.43ks code to be reviewed.

Function B Investigation

In the afternoon, the leader arranged to test function B. The customer said that this function seemed to be faulty. He wanted to know if it was a code problem on our side. He had logged on to redmine and asked us to investigate, so I tested it and finally found that there was no problem in the simulator, but there was a problem in the real-machine environment. The customer later said it was not the code problem on our side, but the problem of their code merging.

C function test job

I tested 30 use cases and one bug in the black box test of the C function. Another one was put on hold because the simulator could not be tested. The progress may be delayed.

The report above shows at a glance what the young man has done. The young man has not been busy for a day and has done three homework.

 

Step 2. Entry-based

The goal of the entry is to give the report viewer a glance at the overall situation. Many new users worry that the leaders do not understand what they write, so they write a close-up in upper case. In fact, it is a big mistake. Leaders have rich experience. If you write only one sentence, they may understand what you want to express. Therefore, it is better to make the report concise.

The entry method is to extract the core of the work content. The following shows the entry effect:

Function a coding job

1. after reading the demand statement for one hour and referring to outspec and innerspec, I read the entire function a and found a requirement problem, which of the following states can be modified by XXX. After discussing with the team members and leaders, we found that it was a requirement that we could not interpret on our side, and QA had already gone out as a requirement question.

2. According to the SD completed last week, PG started around and code about 0.2ks was compiled in the morning. It took an hour in the afternoon to complete the implementation of the entire function A, with a total of 0.43ks code to be reviewed.

Function B Investigation

1. the leader arranged to test function B. The customer said that this function seemed to be faulty. He wanted to know if it was a code problem on our side. He had logged on to redmine and asked us to investigate it. So I tested it, finally, we found that there was no problem in the simulator, but there was a problem in the real-machine environment. In the future, the customer was not the code problem on our side, but the problem of code merging.

C function test job

1. I tested 30 use cases for the black box test of the C function and found a bug. Another one was put on hold because the simulator could not be tested. The progress may be delayed.

The above report has already been written. Obviously, in function a's code, the reporter has done two jobs.

 

Step 3. Concise

The report is not a composition, but it is for the boss who has little time to read, so we should avoid the nonsense of a large space, describe the work content in the most refined language, and describe the problem. The concise report is as follows:

Function a coding job

1. Read the Requirement Specification (outspec and innerspec) and find that the requirement is unknown. QA has been submitted.

2. Encoding (0.43ks, to be reviewed)

Function B Investigation

1. The problem found by the customer on redmine is on the customer side. The Code merging is missing and has been solved. For details, refer to redmine.

C function test job

1. Black box testing, 30 tested, one bug found, one simulator cannot be tested (the progress delay may be)

 

Step 4. Data Extraction

In the seven-step method, this step is actually the most difficult, requires experience accumulation, and requires a keen intuition. For this report, let's analyze what data is missing.

1. function a code job →Requirements Specification reading (outspec, innerspec), found that the demand is unknown, has submitted QA

As a reader, if he wants to know what the style is, he cannot find the problem because QA has no serial number and does not mention the logon location. Therefore, you can append data: QA #123, which is used to point to the information of the problem itself.

2. function a code job →Code (0.43ks, to be reviewed)

As a reader, I want to know how much code this function originally estimated, and how much deviation it has from the actual amount of code. Is it planned. He can't know, so he can append data: Estimated amount of code, code deviation, and schedule.

3. B function investigation job →The problem found by the customer on redmine lies in the customer. The Code merging is missing and has been solved. For details, refer to redmine.

1. As a reader who wants to know the specific details of the problem, he cannot know. Therefore, he can mine data: topic #888, which is used to point to the information of the subject.

4. C function test Job → black box test, 30 tested, one bug found, one simulator cannot be tested (the progress delay may be)

As a reader, I only know that the reporter has tested 30 items, but I don't know the total quantity. I don't know how many items are not tested, and whether the job is in the schedule, data that can be mined here: the total number of use cases, the proportion of tested data to the total amount, and the planned schedule.

The modified report content is as follows:

Function a coding job

1. Read the Requirement Specification (outspec and innerspec) and find that the requirement is unknown. QA #123 has been submitted.

2. Encoding

------- Time ------------------- amount of code ---------- progress ------

Set: 2012/9/25-2012/9/30 0.5ks-

Performance: 2012/9/26-0.43ks 100%

---------------------------------------------------------

Function B Investigation

1. The problem found by the customer on redmine is on the customer side. The Code merging is missing and has been solved. For details, refer to redmine Project #888.

C function test job

1. Black box testing. One simulator cannot be tested (the progress delay may be)

------- Time ------------------- Number of Use Cases ---------- progress ------ Number of bugs ------

Set: 2012/9/25-2012/9/30 80-3

Performance: 2012/9/26-30, 38%, 1

--------------------------------------------------------------------

The above report clearly shows the job progress and whether the quality is within the reasonable theoretical threshold.

 

Step 5. graphic application

Graphics are some of the simplest symbols that can be displayed in plain text, mainly including: ■, ▲, ※, △, ①, ⅱ, →, hour ,? ,★.

The use of graphics depends on experience and aesthetic feeling. Therefore, how to use it flexibly depends on your own grasp. Here are two examples.

1. Use ※※※id to identify the potential or potential risks and indicate the specific content of the risks.

2. For a large category, you can use ■ to identify it. Because it is easy to see, you can quickly find the category.

3. If the data size changes, you can use the upper and lower right symbols for identification.

Based on the above three points, the modified report is as follows:

■ A function encoding job

1. Read the Requirement Specification (outspec and innerspec) and find that the requirement is unknown. QA #123 has been submitted.

2. Encoding

------- Time ------------------- amount of code ---------- progress ------

Set: 2012/9/25-2012/9/30 0.5ks-

Performance: 2012/9/26-0.43ks limit 100%

---------------------------------------------------------

■ B function investigation

1. The problem found by the customer on redmine is on the customer side. The Code merging is missing and has been solved. For details, refer to redmine Project #888.

■ C function test job

1. Black box testing. One cannot be tested ※

------- Time ------------------- Number of Use Cases ---------- progress ------ Number of bugs ------

Set: 2012/9/25-2012/9/30 80-3

Performance: 2012/9/26-30, 38%, 1 Region

--------------------------------------------------------------------

※: Testing cannot be performed on the simulator, which may affect the plan progress of the black box testing for the C function.

 

Step 6. Remove Redundancy

The report category should be as specific as possible, and the above report can be improved. For example, the topics proposed by function a coding job 1 and function B investigation work belong to the same type, therefore, we can extract 1 and B from A to remove redundancy and create a new category. The modified report is as follows:

■ A function encoding job

------- Time ------------------- amount of code ---------- progress ------

Set: 2012/9/25-2012/9/30 0.5ks-

Performance: 2012/9/26-0.43ks limit 100%

---------------------------------------------------------

■ C function test job

------- Time ------------------- Number of Use Cases ---------- progress ------ Number of bugs ------

Set: 2012/9/25-2012/9/30 80-3

Performance: 2012/9/26-30, 38%, 1 Region

--------------------------------------------------------------------

※One test case is unavailable: The test cannot be performed on the simulator, which may affect the plan progress of the black box test for the C function.

■ Subject & QA

①. QA #123. The requirement of the function is unknown, and it cannot be determined which statuses of xxx can be modified.

②. Subject #888. The problem that the customer asked us to investigate and merge code has been solved.

 

Step 7. Format and beautify

Finally, we need to keep improving the report format. The above report still has aesthetic issues. The adjustment of the report format depends on the individual's attitude and aesthetic feeling, the following is the revised report:

Zhang San's Work Report

■ A function encoding job

------- Time ------------------- amount of code ------ progress ------- status ----------------

Set: 2012/9/25-2012/9/30 0.5ks --

Performance: 2012/9/26-0.43ks limit 100% RMB (finished, to be reviewed)

------------------------------------------------------------------------

■ C function test job

------- Time ------------------- Number of Use Cases ------ progress ------ Number of bugs ----- status -------

Set: 2012/9/25-2012/9/30 80-3-

Performance: 2012/9/26-30, 38%, 1 success → (in the hands)

------------------------------------------------------------------------

※One test case is unavailable: The test cannot be performed on the simulator, which may affect the plan progress of the black box test for the C function.

■ Subject & QA

① QA #123 the requirement for a function is unknown. It is impossible to determine which statuses of xxx can be modified.

②. Question #888 the problem that the customer asked us to investigate and merge code has been solved.

Finally, I hope everyone can write high-quality reports. Thank you for reading this article. What are the better skills? I hope you can give me some advice to improve your skills.