编写 个jdbc程序步骤_如何通过7个步骤编写（更好）发行说明

编写 个jdbc程序步骤

For some businesses, release notes are the only way product enhancements are communicated to customers. For others, they’re a sideline, developed entirely separately from user communications.

对于某些企业，发行说明是将产品增强功能传达给客户的唯一方法。 对于其他人，它们是副业，完全与用户通信分开开发。

But if you want to do more with less — if you want to improve customer retention communications without having to do a stack more work — your release notes could be an unexpected, but valuable answer. Especially if they’re well done.

但是，如果您想花更少的钱做更多的事情-如果您想改善客户保留沟通而不必做更多的工作，那么您的发行说明可能是一个出乎意料但有价值的答案。 特别是如果他们做得很好。

Release notes document new features, enhancements to functionality, and bug fixes. They’re usually concise and fairly direct, and naturally assume a level of familiarity with your product. The process I’ve set out below should make it easy to produce good quality release notes for your product that meet that need for your business and your customers.

发行说明记录了新功能，功能增强和错误修复。 它们通常是简洁明了且直接的，并且自然会假定您对产品有一定程度的了解。 我在下面列出的过程应该使为您的产品轻松生成高质量的发行说明，从而满足您的业务和客户的需求。

But, if you want, this process will also provide you with solid fodder for other release communications — like emails or blog posts or feature tours — that can help remind customers how committed you are to improving what you offer to them. And let’s face it, we all want to know we’re loved even after we’ve made a choice and signed up with a service.

但是，如果您愿意的话，此过程还将为您提供用于其他发行通讯的坚实基础，例如电子邮件或博客文章或功能介绍-可以帮助提醒客户您对改进向他们提供的产品的决心。 让我们面对现实吧，即使我们已经做出选择并注册了服务，我们都希望知道自己被爱着。

Let’s see how this can work for you.

让我们看看它如何为您工作。

1.明确目标对象和注释的目的 (1. Be clear on your target audience, and the purpose of the notes)

Who reads release notes? For some products, the majority of users will check out each release note; for others, it’s a very select, specific subset of the main userbase.

谁在阅读发行说明？ 对于某些产品，大多数用户将签出每个发行说明。 对于其他人，这是主要用户群的一个非常特定的子集。

Once you know who you’re creating the release notes for, you can understand why they’re reading the notes. And that drives the next step.

一旦知道要为谁创建发行说明，就可以了解他们为什么要阅读发行说明。 这驱动了下一步。

The release notes for the product I work on aren’t read by anyone but a very small percentage of users within key client accounts. And they have very specific reasons for reading the release notes – some have internal documentation they need to keep updated, for example.

我正在研究的产品的发行说明不会被任何人阅读，但是关键客户帐户中只有极少数用户可以阅读。 他们有非常具体的理由来阅读发行说明-例如，有些人具有内部文档需要不断更新。

But for some products, the release notes are read by a large portion of users who want to avoid the marketing spin – who want to get to the heart of the product and hear direct from its makers. Knowledge like that won’t just inform what you include and exclude – it can impact the tone in which you write the notes, and how you present them.

但是对于某些产品，很多用户都希望阅读发行说明，这些用户希望避免营销混乱，他们希望深入了解产品的核心，并直接听取制造商的意见。 这样的知识不仅会告知您包含和排除的内容，还会影响您书写便笺的音调以及呈现方式。

2.弄清楚他们需要知道什么 (2. Work out what they need to know)

Release notes are generally expected to document what changes have been made in the current release of your product. So obviously, you’ll have an idea of what you need your readers to know about.

通常，发行说明应记录在您产品的当前发行版中进行了哪些更改。 所以很明显，你就会有你需要什么你的读者了解一个想法。

But it’s also important to think about what your readers feel they need to know about. For example, we document bug fixes in a way that ensures whoever reported or noticed the bug will be able to identify it in the list and know it’s been fixed. But we don’t go into depth on each bug fix, since no one needs (or, to be honest wants) to read all that information.

但是，考虑一下读者认为需要了解的内容也很重要。 例如，我们以某种方式记录错误修复，以确保无论是报告还是注意到该错误的人都可以在列表中标识该错误并知道已修复。 但是，由于没有人需要(或说实话要)读取所有这些信息，因此我们没有深入研究每个错误修复程序。

At this point, it’s also a good idea to consider when your readers will need access to the release notes. On the day of release? A week before, so they have time to review them? This will help you schedule the creation of release notes around the work of actually building and deploying the release.

此时，考虑读者何时需要访问发行说明也是一个好主意。 发布当天？ 一周前，所以他们有时间对其进行审查？ 这将帮助您安排围绕实际构建和部署发行版的工作来计划发行说明的创建。

3.确定您在此版本中所做的工作 (3. Identify what you’ve done in this release)

It sounds simple enough, but if you put a good process in place for this step, it will smooth the production of each release note.

听起来很简单，但是如果您为这一步骤设置了良好的流程，它将使每个发行说明的制作变得顺畅。

For example, you might decide to have a shared document that your developers and product owners can update progressively as work’s completed, rather than at the very end, which can leave you trying to compile the notes in a rush.

例如，您可能决定拥有一个共享文档，开发人员和产品所有者可以在工作完成时(而不是在工作结束时)逐步更新它们，这可能会使您急忙编写注释。

You might also break that document up into sections that reflect the kinds of work that’s typically done—say, new features, enhancements to existing functionality, and bug fixes. This will make it easy to see at a glance whether everything in the release has been included in the document.

您也可以将该文档分为几个部分，以反映通常完成的工作，例如新功能，现有功能的增强以及错误修复。 这将使您一目了然，轻松查看该发行版中的所有内容是否已包含在文档中。

It will also make it easier to structure the release notes themselves than if you simply had an unstructured list of new stuff.

与仅具有非结构化的新内容列表相比，这也将使结构化发行说明本身更容易。

4.确定您需要包括的内容 (4. Decide what you need to include)

As they’re contributing information to your release note document, your devs and product owners probably won’t be thinking about the end user. So when it comes to preparing the release notes, you’ll need to work out which bits of information to include, and which can be omitted.

由于他们正在向发行说明文档提供信息，因此您的开发人员和产品所有者可能不会考虑最终用户。 因此，在准备发行说明时，您需要确定要包括哪些信息，哪些可以省略。

I’m thinking particularly of bug fixes I mentioned above, but you may also have to balance the voluble contributions of some against the thinner contributions of others to the notes.

我特别考虑的是上面提到的错误修复程序，但您可能还必须权衡某些工具的巨大贡献与其他工具在注释中的贡献。

More words, screenshots, and detail about one feature or enhancement than another will generally be taken to reflect the relative importance or complexity of that item, so keep that in mind as you work out how deeply you’ll cover each item in the list.

通常会用更多的单词，屏幕快照以及有关一项功能或增强功能的细节来反映一项功能或增强功能的细节，以反映该功能的相对重要性或复杂性，因此在确定列表中每个功能的覆盖范围时，请记住这一点。

5.如果需要，制定故事情节或消息 (5. Work out a storyline or messaging if you need to)

It’s not always needed, but sometimes a storyline can help to put your improvements into context. I’m not talking about adding words for the sake of it here, or turning your nice, concise release notes into a marketing tool. What I mean is that the order in which you present your information can help users to understand the changes you’ve made. So think that through.

并非总是需要它，但是有时故事情节可以帮助您将改进内容放在上下文中。 我不是在这里为此而添加单词，也不是在将您简洁漂亮的发行说明变成一种营销工具。 我的意思是，您显示信息的顺序可以帮助用户理解您所做的更改。 所以想一想。

For example, a recent release note I prepared made mention of a facelift for the product, as well as a major feature addition. The facelift entailed merely cosmetic changes—it didn’t affect functionality of the locations of items in the interface. The feature addition was a much bigger piece of work, with bigger long-term implications for users.

例如，我准备的最新发行说明中提到了该产品的改头换面，以及主要功能的增加。 改头换面只需要进行外观上的更改—不会影响界面中项目位置的功能。 该功能的增加是一项更大的工作，对用户具有更大的长期影响。

Which would you cover first? We chose to open with the facelift, since that’s what users would notice first the next time they used our software. The new feature was listed after that, but contained more screenshots and detail. One of the reasons this made good sense was because the new feature looked significantly different than much of the rest of the app, so putting it in the context of a visual refresh allowed us to skip more discussion of that fact.

您首先要涵盖哪一个？ 我们选择改头换面，因为这是用户下次使用我们的软件时会首先注意到的。 此后列出了新功能，但其中包含更多屏幕截图和详细信息。 之所以说这很有意义，是因为新功能看上去与该应用程序的其他大部分功能明显不同，因此将其置于视觉刷新的上下文中可以使我们跳过对该事实的更多讨论。

6.起草笔记 (6. Draft your notes)

Most users expect release noted to be direct and concise. They’re there to get the facts. That said, it’s probably best to interpret each feature or fix from the point of view of your target audience. What does it mean for them?

大多数用户期望发布的内容简洁明了。 他们在那里了解事实。 也就是说，最好是从目标受众的角度来解释每个功能或修复程序。 对他们意味着什么？

For example, a change to your app may make it easier for your support staff to set up additional user accounts for enterprise clients. What that means to users of the release notes is: it’s quicker or easier for new staff with those clients to get access to the corporate account. So put it in those terms.

例如，对应用程序进行的更改可能会使支持人员更轻松地为企业客户设置其他用户帐户。 对于发行说明的用户而言，这意味着：与这些客户一起工作的新员工可以更快或更轻松地访问公司帐户。 因此，用这些术语来说。

7.重新利用您需要进行其他通信的目的 (7. Repurpose what you need for other communications)

If they’re well planned and written, your release notes can act as a springboard for other communications, possibly directed at other user audience segments, to highlight what’s new in your product.

如果它们的计划和编写合理，则发行说明可以充当其他交流的跳板，可能会针对其他用户细分受众群，以突出显示产品中的新功能。

Once you’ve nailed down the release notes, it should be pretty easy to see what can be reformulated into in-app notifications or tours, used to review help content, and repurposed and developed into blog posts, newsletter items, and other retention content.

一旦确定了发行说明，就很容易看到可以重新构造为应用内通知或导览的内容，用于查看帮助内容以及将其重新用途并开发为博客文章，时事通讯和其他保留内容的信息。 。

您如何开发发行说明？ (How do you develop release notes?)

That’s it—not a difficult procedure, although if you have a number of moving parts in your production process, release notes can take some doing.

就是这样，这不是一个困难的过程，尽管如果生产过程中有许多活动部件，发行说明可能会有所作为。

But if you produce good release notes, you can get much more out of the work you put into them. They can give you a real head start when it comes to communicating about changes to a broader audience than may read your release notes now.

但是，如果您制作出良好的发行说明，则可以从投入其中的工作中获得更多收益。 与现在阅读您的发行说明相比，与更广泛的受众群体交流变更时，它们可以为您提供真正的开端。

Do you have a process for producing release notes? And do they play into your customer retention efforts? I’d love to hear how you do it in the comments.

您有生产发行说明的过程吗？ 它们是否会影响您的客户保留工作？ 我很想听听您在评论中的做法。

翻译自: https://www.sitepoint.com/write-better-release-notes/

编写 个jdbc程序步骤