using Rugrid.Sdaid.Notation.Documents;
namespace Rugrid.Sdaid.Epas.Vision
{
/// <summary>
/// Видение Сервиса «Оценка потенциала энергосбережения» (ОПЭС) — зонтик над модулями
/// ЭНЗС, МВЭР и ЭНТС. Главная страница сайта спецификации.
/// </summary>
public class DOC_EpasVision : IVisionDocument, IFolder<EpasVisionFolder>
{
public static string _refName = "ОПЭС — видение Сервиса";
public string Name => "Сервис «Оценка потенциала энергосбережения» ПАО «Россети»";
public string Description =>
@"Инструменты для оценки потенциала энергосбережения на объектах ПАО «Россети»: зданиях, транспортных средствах, подстанциях.";
public string Version => "0.1";
public string Status => "draft";
public string[] Comments => new string[0];
public static string Product = """"
## Назначение
Сервис «Оценка потенциала энергосбережения» (**ОПЭС**) предоставляет инструменты для оценки
потенциала энергосбережения на объектах ПАО «Россети»: зданиях, транспортных средствах,
подстанциях.
Оценка по каждому виду объектов ведётся отдельным модулем.
"""";
public static string Modules = $$""""
## Модули
| Модуль | Объект оценки | Состояние |
|---|---|---|
| {{SdaidAnchors.RefTo<Rugrid.Sdaid.Epas.Ntr.Vision.DOC_ServiceEnterVision>()}} | здания: тепловая и электрическая энергия | в эксплуатации, спецификация перенесена в SDAID |
| {{SdaidAnchors.RefTo<Rugrid.Sdaid.Epas.Mver.Vision.DOC_MverVision>()}} | подстанции: подбор решений по данным об оборудовании | реализован; спецификация ведётся вне SDAID |
| {{SdaidAnchors.RefTo<Rugrid.Sdaid.Epas.Nts.Vision.DOC_NtsVision>()}} | транспортные средства: автомобильное топливо | проектируется |
**Платформа** — общее для всех модулей: хост API, организационная структура, загрузка из АИС
ОИА ПЭО, справочники, безопасность и обслуживание.
"""";
public static string SpecStructure = """"
## Как устроена эта спецификация
**EPAS** (Energy Efficiency Potential Assessment) — техническое обозначение Сервиса: имя сборки
спецификации, корень адресов на этом сайте (`/Epas/<модуль>/…`), префикс в коде.
Спецификация — один компилируемый проект; модули разделены папками и графом связей, а не
отдельными сборками. Так сделано потому, что в коде модули тоже не разделены сборками: общий
хост, общий read-слой, общий импорт из АИС. При делении спеки на сборки общему коду не нашлось
бы дома.
| Раздел | Что внутри |
|---|---|
| Методология | как ведём спецификацию: правила, шаблоны, порядок изменений |
| Платформа | общее для всех модулей |
| ЭНЗС, МВЭР, ЭНТС | модули: видение, домен, методика расчёта, UI |
Внутри модуля разделы одинаковые: «Видение», «Домен», «Backend» (методика и модель входных
данных расчёта), «UI», «Запросы на изменение».
Правило, общее для всей спеки: **сначала правило появляется в спецификации, потом в коде.**
Спецификация — целевая модель Сервиса; запрос на изменение хранит исходный текст требования
и его разбор.
"""";
}
}